[jira] [Created] (IMAGING-81) Add more Javadoc to main package

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (IMAGING-81) Add more Javadoc to main package

ASF GitHub Bot (Jira)
Gary Lucas created IMAGING-81:
---------------------------------

             Summary: 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


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

       
Reply | Threaded
Open this post in threaded view
|

[jira] [Updated] (IMAGING-81) Add more Javadoc to main package

ASF GitHub Bot (Jira)

     [ 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

       
Reply | Threaded
Open this post in threaded view
|

[jira] [Resolved] (IMAGING-81) Add more Javadoc to main package

ASF GitHub Bot (Jira)
In reply to this post by ASF GitHub Bot (Jira)

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

Damjan Jovanovic resolved IMAGING-81.
-------------------------------------

       Resolution: Fixed
    Fix Version/s: 1.0
         Assignee: Damjan Jovanovic  (was: Luc Maisonobe)

Patch committed. Thank you for your contribution! Resolving fixed.

               

> 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: Damjan Jovanovic
>            Priority: Minor
>             Fix For: 1.0
>
>         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