[
https://issues.apache.org/jira/browse/TOMEE-2346?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
David Blevins updated TOMEE-2346:
---------------------------------
Description:
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.
Origin of the idea is we used
was:
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.
> 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.
>
> Origin of the idea is we used
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
