[
https://issues.apache.org/jira/browse/TOMEE-2346?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17147411#comment-17147411
]
David Jencks commented on TOMEE-2346:
-------------------------------------
I think this is a good idea only for javadoc that is integrated with the rest
of the documentation site. Otherwise there is too much burden to keep links
stable forever.
In any case, doing this will be tricky since it involves predicting the future:
the javadoc has to be generated first, and it has to have links into something
that doesn't exist yet, the example pages. No doubt solvable, but not
straightforwardly reliable.
> 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
> Priority: Major
>
> 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
(v8.3.4#803005)
