-
-
Notifications
You must be signed in to change notification settings - Fork 735
Support @copydoc or enhance @inheritdoc #304
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
Comments
TypedDoc's I'm really wary to add additional copying methods which won't be recognized by VSCode, and will result in worse docs for people using the language service to read documentation (the majority of declaration file use, in my experience) I'm open to doing something like this if enough people want it, but a proposal like it needs to describe how it will play with comment tags, where it's permitted, when it is resolved, etc... I don't want to add a feature that few people know exists, and fewer how to use properly, like several existing features... |
Uh oh!
There was an error while loading. Please reload this page.
I want some features to be added.
@copydoc
Copy definition from another one.
If I need to define same content on another object, then it's very annoying. Look at the below codes, then you may understand how I am suffering from duplicated definitions
@inheritdoc
The @inheritdoc feature in TypeDoc copies definition from its parent class. However, it's standalone. It doesn't allow using the @inheritdoc as subsidiary one.
Overriding a method means some logics are changed and some explanation is required. I want to combine @inheritdoc with customized comments explaining what is changed.
The text was updated successfully, but these errors were encountered: