Skip to content
This repository has been archived by the owner on Mar 7, 2019. It is now read-only.

{@inheritDoc} tags are not being processed #59

Open
manoelcampos opened this issue Jan 23, 2017 · 2 comments
Open

{@inheritDoc} tags are not being processed #59

manoelcampos opened this issue Jan 23, 2017 · 2 comments

Comments

@manoelcampos
Copy link
Contributor

When the documentation of a subclass/interface is extended using a {@inheritdoc} tag, such a tag is not processed by javasphinx.

Instead of showing the documentation from the superclass/interface, the {@inheritdoc} tag just shows up in the built documentation.

An example of this issue can be found here.

@dljsjr
Copy link

dljsjr commented Mar 24, 2017

We're thinking about moving over to Sphinx for our documentation as well and we make heavy use of the inherit doc tag.

@c2nes
Copy link
Contributor

c2nes commented Mar 26, 2017

Sorry for not responding sooner. This might be do-able, but I think it will be a decent chunk of work. I believe the difficult part will be actually determining which method is being overridden. At a minimum the type hierarchy would need to be modeled and some understanding of generics would need to be added (to handle overriding methods with generic parameters).

I'd be happy to review a PR (a design proposal might actually be a better place to start for this), but I unfortunately don't have the time to work on this myself in the near term.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants