Skip to content

Not updated DocComments? #183

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
Closed
aleung opened this issue Jan 27, 2016 · 1 comment
Closed

Not updated DocComments? #183

aleung opened this issue Jan 27, 2016 · 1 comment

Comments

@aleung
Copy link

aleung commented Jan 27, 2016 •
edited by aciccarello
Loading

Is the DocComments page (http://typedoc.org/guides/doccomments/) up to date?

It lists only two tags @param and @return are understood. All other tags will be rendered as definition lists. However I found that more tags are handled when I read typedoc source code.

For example, @inheritdoc should be used to copy comments from interface to implementation.(#78)

What's more, in DocComments it said:

TypeDoc automatically copies comments and tags of the function implementation to its signatures for you.

However I can't make it work. No doc comment of dynamic module neither. Am I missing any configuration or tag which is undocumented?
@aciccarello
Copy link
Collaborator

The DocComments page has not been updated. There are several tags that could be included such as @hidden (#364).

PRs are always welcome.

@Gerrit0 Gerrit0 closed this as completed Feb 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@aleung @aciccarello @Gerrit0