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

Posted to commits@tomee.apache.org by "Roberto Cortez (JIRA)" <ji...@apache.org> on 2019/01/26 00:55:02 UTC

[jira] [Updated] (TOMEE-2347) Use Asciidoc for all Javadoc

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

Roberto Cortez updated TOMEE-2347:
----------------------------------
    Fix Version/s:     (was: 8.0.0-M2)
                   8.0.0-M3

> Use Asciidoc for all Javadoc
> ----------------------------
>
>                 Key: TOMEE-2347
>                 URL: https://issues.apache.org/jira/browse/TOMEE-2347
>             Project: TomEE
>          Issue Type: Wish
>            Reporter: David Blevins
>            Priority: Major
>             Fix For: 8.0.0-M3
>
>
> here's a fun idea, write our javadoc in asciidoc format
>  * [https://asciidoctor.org/news/2013/06/03/asciidoclet-announcement/]
> Where there is javadoc, it usually is not in the required html format, so this would actually bring us closer in line with what we have done in practice.
>  
> Other fun bonus, if the majority of our javadoc was in asciidoc, we could potentially improve the site generator to not just pull README.md and README.adoc files as it currently does, but it could potentially pull chunks of asciidoc straight from the source code and use it to fill out some of the online docs.  This would be done separately in TOMEE-2341



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