incubator-crunch-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Matthias Friedrich (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (CRUNCH-95) Improve Javadoc
Date Sun, 14 Oct 2012 09:09:03 GMT

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

Matthias Friedrich updated CRUNCH-95:
-------------------------------------

    Attachment: 0001-CRUNCH-95-Improve-Javadocs.patch

Run "mvn javadoc:aggregate" from the base directory, then see target/site/apidocs/.
                
> Improve Javadoc
> ---------------
>
>                 Key: CRUNCH-95
>                 URL: https://issues.apache.org/jira/browse/CRUNCH-95
>             Project: Crunch
>          Issue Type: Improvement
>    Affects Versions: 0.3.0
>            Reporter: Matthias Friedrich
>            Assignee: Matthias Friedrich
>             Fix For: 0.4.0
>
>         Attachments: 0001-CRUNCH-95-Improve-Javadocs.patch
>
>
> As discussed on crunch-dev we should structure our API documentation better to help new
users. This ticket is a first step towards that goal, consisting of two parts:
>    * Configure the javadoc plugin to include only client-facing packages
>    * Provide descriptions for these packages, improving the overview page
> Moving code around is more controversial and will be done in a separate ticket.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message