You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@nutch.apache.org by "Lewis John McGibbney (Created) (JIRA)" <ji...@apache.org> on 2011/12/12 19:21:32 UTC
[jira] [Created] (NUTCH-1218) Improve trunk API documentation
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
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
Re: [jira] [Commented] (NUTCH-1218) Improve trunk API documentation
Posted by Markus Jelsma <ma...@openindex.io>.
looks fine
> [
> https://issues.apache.org/jira/browse/NUTCH-1218?page=com.atlassian.jira.p
> lugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13175966#comm
> ent-13175966 ]
>
> Lewis John McGibbney commented on NUTCH-1218:
> ---------------------------------------------
>
> Does anyone have any objections for me to hack away at this making commits
> when I can? The intention is to work my way through the core classes,
> providing a description of each package, then get in to more detail with
> individual classes within the 'core' bunch of classes.
>
> After this I'll move on to the plugin's.
>
> After that I'll move on to Nutchgora!!!
>
> > 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
[jira] [Commented] (NUTCH-1218) Improve trunk API documentation
Posted by "Lewis John McGibbney (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/NUTCH-1218?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13175966#comment-13175966 ]
Lewis John McGibbney commented on NUTCH-1218:
---------------------------------------------
Does anyone have any objections for me to hack away at this making commits when I can? The intention is to work my way through the core classes, providing a description of each package, then get in to more detail with individual classes within the 'core' bunch of classes.
After this I'll move on to the plugin's.
After that I'll move on to Nutchgora!!!
> 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
[jira] [Updated] (NUTCH-1218) Improve trunk API documentation
Posted by "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
[jira] [Commented] (NUTCH-1218) Improve trunk API documentation
Posted by "Markus Jelsma (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/NUTCH-1218?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13168805#comment-13168805 ]
Markus Jelsma commented on NUTCH-1218:
--------------------------------------
I'm not very familiar with ant but i'd think it's just a wildcard for a classpath.
> 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
[jira] [Updated] (NUTCH-1218) Improve trunk API documentation
Posted by "Markus Jelsma (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/NUTCH-1218?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Markus Jelsma updated NUTCH-1218:
---------------------------------
Fix Version/s: (was: 1.5)
1.6
20120304-push-1.6
> 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.6
>
> 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
[jira] [Commented] (NUTCH-1218) Improve trunk API documentation
Posted by "Lewis John McGibbney (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/NUTCH-1218?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13175967#comment-13175967 ]
Lewis John McGibbney commented on NUTCH-1218:
---------------------------------------------
Another thing, even if I make the changes to trunk, it would be great to view them dynamically on the trunk Javadoc site [1] e.g. publish them after every commit to see the actual changes at incremental stages. Any advice on this? From looking at build.xml, it appears that this we only fully publish the Javadoc when releasing... Is this the case? If not then can someone please advise me otherwise? Thanks guys
> 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