You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@tomee.apache.org by "David Blevins (JIRA)" <ji...@apache.org> on 2018/12/09 04:29:00 UTC

[jira] [Created] (TOMEE-2346) Generate Javadoc '@see' references to our examples and docs

David Blevins created TOMEE-2346:
------------------------------------

             Summary: Generate Javadoc '@see' references to our examples and docs
                 Key: TOMEE-2346
                 URL: https://issues.apache.org/jira/browse/TOMEE-2346
             Project: TomEE
          Issue Type: Sub-task
          Components: Website
            Reporter: David Blevins


We could link the javadoc to actual documents that reference that particular class.

Imagine that we index all the examples by what classes they use, including api classes.  We grab a copy of the source for all those classes and add a bunch of `@see` elements to the source code to reference the page that will be generated.

The resulting javadoc would then have links to examples that better show how that annotation or class can work.

 

Incredibly cool idea.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)