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 2020/06/29 05:41:00 UTC

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

     [ https://issues.apache.org/jira/browse/TOMEE-2346?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Blevins reassigned TOMEE-2346:
------------------------------------

    Assignee: Willes Reis

> 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
>            Assignee: Willes Reis
>            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)