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

Bug: @returns tag missing in generated markdown #694

Closed
m1rn opened this issue Sep 29, 2024 · 2 comments
Closed

Bug: @returns tag missing in generated markdown #694

m1rn opened this issue Sep 29, 2024 · 2 comments
Labels
bug Issue raised as a bug.

Comments

@m1rn
Copy link

m1rn commented Sep 29, 2024

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

Description:

When using typedoc with the typedoc-plugin-markdown extension, the generated markdown content omits the @returns tag from the documentation comments. This results in incomplete documentation, as the @returns information is crucial for understanding the return value of functions and types.

Expected Behavior:

The markdown documentation should include the content from the @returns tag, as it does when generating HTML using the base typedoc setup. The @returns description should be visible under each type that has it documented.

Actual Behavior:

The @returns tag and its description are missing entirely from the generated markdown output.

Steps to Reproduce:

  1. Set up a TypeScript project with typedoc and typedoc-plugin-markdown.
  2. Include a type with a @returns tag in the doc comments.
  3. Run the typedoc command to generate markdown documentation.
  4. Check the generated markdown for the missing @returns section.

You can view the minimum reproducible example here:
Reproduction URL

Environment:

  • typedoc version: 0.26.7
  • typedoc-plugin-markdown version: 4.2.8
  • TypeScript version: 5.5.4
  • Node.js version: 5.5.4

Additional Context:

This issue may cause incomplete documentation for users who rely on markdown output for their TypeScript projects. It would be helpful to ensure all relevant tags, including @returns, are properly processed in the markdown output.

TypeDoc configuration

No response

Expected behavior

No response

@m1rn m1rn added the bug Issue raised as a bug. label Sep 29, 2024
@tgreyuk
Copy link
Member

tgreyuk commented Sep 30, 2024

thanks - will go into next release.

@tgreyuk
Copy link
Member

tgreyuk commented Oct 1, 2024

fix in [email protected].

@m1rn m1rn closed this as completed Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue raised as a bug.
Projects
None yet
Development

No branches or pull requests

2 participants