Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add style support for "deprecated" #557

Open
bshaffer opened this issue Oct 2, 2023 · 0 comments
Open

feat: add style support for "deprecated" #557

bshaffer opened this issue Oct 2, 2023 · 0 comments
Assignees
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@bshaffer
Copy link

bshaffer commented Oct 2, 2023

The property and value status: deprecated works in the TOC to mark certain classes/pages as deprecated. When a class, method, or parameter have status: deprecated we should have a similar way to mark stylistically that it's deprecated.

syntax:
      parameters:
        -
          id: data
          var_type: array
          description: 'Optional. Data for populating the Message object.'
          status: deprecated

This would render html like the following:

<tr>
      <td><code>{{{id}}}</code></td>
      <td>
        <code>{{#var_type}}{{{var_type}}}{{/var_type}}{{^var_type}}{{{type.specName.0.value}}}{{/var_type}}</code>
        <br>
        {{{description}}}
        {{>partials/uref/parameters}}
 {{if status == deprecated}}
 <aside class="deprecated">
  <b>Deprecated:</b> A note or tip for a deprecated feature, product, or service.
 </aside>
 {{/if status == deprecated}} 
      </td>
    </tr>

A feature like this would be useful for all languages!

@bshaffer bshaffer added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. priority: p3 Desirable enhancement or fix. May not be included in next release. labels Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

2 participants