-
Notifications
You must be signed in to change notification settings - Fork 19
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
[Feature] Full support of TsDoc tags #10
Comments
By the way, I tried to use |
@dhutaryan how did you use it? for the class/interface or their members? |
@skoropadas I used it for simple function |
Sometimes I want to hide entire classes, interfaces: /**
* @internal
*/
export class MyClass { } But I realized that @internal only supports member properties and methods. |
@HyperLife1119 yes, this ticket with full support for |
@skoropadas As I understand, from the table above, adding support for However, I can see from the source code that tags are parsed using ts-morph, I'm curious, why not use ts-doc parser provided by Microsoft ( |
@AdrianKokot I initially used As for the The main issue here is that |
Ok, thanks for the explanation. I thought that |
Description
At the moment NgDoc supports only a few TSDoc tags, we need to expand support for tags to make it clear to users which standard we support and also add documentation on how to use them. Below is a table of tags with the current and required support
@alpha
@beta
@decorator
@deprecated
@defaultValue
@eventProperty
@example
@experimental
@inheritDoc
@internal
@label
@link
@override
@packageDocumentation
@param
@privateRemarks
@public
@readonly
readonly
keyword, so there is no need to implemement this tag@remarks
@returns
@sealed
@see
@throws
@typeParam
@virtual
Proposed solution
Some tags are not needed (for example, @decorator), since the documentation engine collects this information from the code, but most of them are necessary in order to display warnings or sort the documentation content.
It doesn't mean that you can't use these tags, it means that they will not be covered by NgDoc and displayed in documentation on API pages.
Alternatives considered
The text was updated successfully, but these errors were encountered: