[jira] [Updated] (NUTCH-1218) Improve trunk API documentation

["Lewis John McGibbney (Updated) (JIRA)" <ji...@apache.org>]

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

Lewis John McGibbney updated NUTCH-1218:
----------------------------------------

    Attachment: NUTCH-1218.patch

This patch is a work in progress. So far it includes the following
1) Covers half of the core packages by substantiating on the minimal package.html descritpions.
2) Fixes the issue with the ${Name} variable which was incorrectly specified
3) Adds missing plugins to the Javadoc Ant target in build.xml.

There is an issue I have stumbled across, can anyone explain in default.properties, why there is a _*:\_ after some plugin class names when there is not this after others?
{code}

#
# Parse Plugins
#
plugins.parse=\
   org.apache.nutch.parse.ext*:\
   org.apache.nutch.parse.js:\
   org.apache.nutch.parse.swf*:\
   org.apache.nutch.parse.tika:\
   org.apache.nutch.parse.zip

{code}


                
> Improve trunk API documentation
> -------------------------------
>
>                 Key: NUTCH-1218
>                 URL: https://issues.apache.org/jira/browse/NUTCH-1218
>             Project: Nutch
>          Issue Type: Sub-task
>          Components: documentation
>    Affects Versions: 1.4
>            Reporter: Lewis John McGibbney
>            Assignee: Lewis John McGibbney
>             Fix For: 1.5
>
>         Attachments: NUTCH-1218.patch
>
>
> The trunk API Java documentation could do with some improving. This issue should track that. It should however not seek to change any functionality within the codebase, only to substantiate and improve the existing documentation.  

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