8000 Show @deprecated text in the output · Issue #90 · jsdoc2md/jsdoc-to-markdown · GitHub
[go: up one dir, main page]
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.

Sign up for GitHub

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

Jump to bottom

Show @deprecated text in the output #90

Closed
ghost opened this issue Sep 4, 2016 · 7 comments
Closed

Show @deprecated text in the output #90

ghost opened this issue Sep 4, 2016 · 7 comments
Labels
enhancement template Requires a change to a dmd partial/helper

Comments

@ghost
Copy link
ghost commented Sep 4, 2016 •
edited by ghost
Loading

Hi,

I use the v1.3.7

In the source, I have added :

    @deprecated Use {@link Di#set} instead
    @method

And the output is :

Deprecated
Kind: instance method of Di

The text "Use Di#set instead" doesn't exist in output. Original jsdoc template shows it.

Thanks
@75lb
Copy link
Member
75lb commented Sep 4, 2016

hi, sorry - has been a busy weekend.. will look tomorrow..

@75lb
Copy link
Member
75lb commented Sep 5, 2016

Hi, currently text set with the @deprecated tag is not shown in the output.. i will add this.

@75lb 75lb closed this as completed Sep 5, 2016
@75lb 75lb assigned 75lb and unassigned 75lb Sep 5, 2016
@75lb 75lb reopened this Sep 5, 2016
@75lb 75lb changed the title Deprecated without text Show @deprecated text in the output Sep 5, 2016
@75lb 75lb added the template Requires a change to a dmd partial/helper label Aug 27, 2024
@myarmolinsky
Copy link

Hi, any updates regarding this issue? I'm on ^9.0.0 and text following @deprecated is still not included in the output

@75lb
Copy link
Member
75lb commented Nov 27, 2024

Hi, I have a couple of generated @deprecated tags here in my testbed.. Where do you think the deprecated text should appear?

At the end of the line in italics like the below?

deprecatedFunction2()
Deprecated since version 2.0

Kind: global function

@myarmolinsky
Copy link

Hi, I expected it to appear right next to the Deprecated, here's my commit in my repo from today: balena-io/balena-sdk@f87ee9f

You can see the Deprecated at the bottom of the DOCUMENTATION.md diff, and the warning below it does not come from the note I left by the @deprecated comment. Instead, it comes from me manually adding it to the description as a temporary fix for it not appearing in the documentation after running npm run build.

Perhaps we're missing something with the way we use jsdoc2md https://github.com/balena-io/balena-sdk/blob/f98ec86d8de4941c67095887c4d7ec99e929ddcf/package.json#L52

I'll have a look again tomorrow, but if you have any idea what may be causing the note to not appear on our end I'm happy to hear your thoughts

75lb added a commit that referenced this issue Nov 28, 2024
@75lb
Display text passed to @deprecated tag. Fixes #90
90f94ec
@75lb
Copy link
Member
75lb commented Nov 28, 2024

Fixed and released in v9.1.0 - let me know if there's anything else.

75lb added a commit to jsdoc2md/dmd that referenced this issue Nov 29, 2024
@75lb
Amend the fix for jsdoc2md/jsdoc-to-markdown#90 so that @link, @linkcode
80fb9a0 
 and @linkplain tags are resolved in the deprecation text.
75lb added a commit that referenced this issue Nov 29, 2024
@75lb
Amended the fix for #90 so that @link, @linkcode and @linkplain tags …
7574e44 
…are resolved in the deprecation text.
@75lb
Copy link
Member
75lb commented Nov 29, 2024

Amended..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement template Requires a change to a dmd partial/helper
Milestone
No milestone
Development

No branches or pull requests
2 participants
@75lb @myarmolinsky
0