commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gary Lucas (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (IMAGING-81) Add more Javadoc to main package
Date Mon, 25 Jun 2012 14:45:43 GMT

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

Gary Lucas updated IMAGING-81:
------------------------------

    Attachment: Lucas_Javadoc_25_June_2012.patch

The following adds Javadoc to Imaging and ImageParser, with at least class-level descriptions
for all the main classes.  I've also scrubbed up some of the existing Javadoc in Imaging.java
(which still referred to Sanselan) and added package.html documentation to some of the packages.
  I hope that this documentation will make it easier for developers to work the the Imaging
library.
                
> Add more Javadoc to main package
> --------------------------------
>
>                 Key: IMAGING-81
>                 URL: https://issues.apache.org/jira/browse/IMAGING-81
>             Project: Apache Commons Imaging
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Gary Lucas
>            Assignee: Luc Maisonobe
>            Priority: Minor
>         Attachments: Lucas_Javadoc_25_June_2012.patch
>
>
> The current version of the Apache Commons Imaging has minimal Javadoc.  While the task
of completely supplying Javadoc for the package would easily require multiple man-months of
effort, it would be useful to add information to at least the top-level package and main classes.


--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message