compodoc icon indicating copy to clipboard operation
compodoc copied to clipboard

[FEATURE] Add support for JavaDoc {@inheritDoc}-tags

Open tommueller opened this issue 7 years ago • 11 comments

Overview of the issue

It would be great to have support for something similiar to JavaDocs {@inheritDoc}. Even better would be to autolink the interfaces or extended classes description if no comment is explicitly given.

tommueller avatar Jul 24 '17 07:07 tommueller

@tommueller Autolink can be added quickly. Did you have an example for {@inheritdoc} ?

vogloblinsky avatar Jul 24 '17 09:07 vogloblinsky

this is a German article: https://christianmoser.me/sinn-unsinn-von-inheritdoc/ but the code-snippets and pictures of the resulting javaDoc basically show pretty well what it does. Hope that helps!

tommueller avatar Jul 24 '17 10:07 tommueller

@vogloblinsky any chance this will make it into the next release? starving for this feature ;)

tommueller avatar Sep 12 '17 09:09 tommueller

same, would love to have this

jotatoledo avatar Dec 17 '17 16:12 jotatoledo

any updates on this?

tommueller avatar Jan 24 '18 09:01 tommueller

In my Angular project, I have lots of inherit docs as follows:

/**
 * @inheritdoc
 */
prop: any;

All them aren't included in my compodoc output, I think this feature is a must have as @inheritdoc is a very common language-doc attribute, I would love to see this in compodoc. :)

odahcam avatar Oct 26 '18 16:10 odahcam

I want the same that says @odahcam

pookdeveloper avatar Sep 30 '19 09:09 pookdeveloper

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Nov 29 '19 10:11 stale[bot]

This issue has been automatically closed because it has not had recent activity. Please file a new issue if you are encountering a similar or related problem. Thank you for your contributions.

stale[bot] avatar Dec 06 '19 11:12 stale[bot]

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.

lock[bot] avatar Feb 04 '20 13:02 lock[bot]

-> https://jsdoc.app/tags-inheritdoc.html

vogloblinsky avatar Feb 09 '22 22:02 vogloblinsky