typedoc
typedoc copied to clipboard
Support @copydoc or enhance @inheritdoc
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.
/**
* This is the parent class.
*
* Blah blah blah...
*/
class ParentClass
{
/**
* Do something.
*/
public domSomething(): void
{
}
}
/**
* This is a child class derived from the {@link ParentClass}
*
* #### [Inherited] {@link ParentClass}
* @copy8doc ParentClass
*/
class ChildClass
{
/**
* On top of its parent, {@link ChildClass.doSomething} do something more.
*
* @inheritdoc
*/
public doSomething(): void
{
}
}