Improving API Java Documentation

[Lewis John Mcgibbney <le...@gmail.com>]

Hi Guys,

Been doing some snooping around the code recently and think that the
API documentation [1] could do with some improving in some areas,
please see corresponding Jira issue [2]. A real minor discrepancy I've
encountered early on is that the ${name} variable is set in
default.properties as ${name} and in build.xml as ${Name}, this means
that it is not recognized within the Javadocs [1]. I propose to change
this to ${name}, and to additionally add a Capital to the variable
value therefore making it Nutch? Any thoughts? Does this require a
Jira to be logged as well?

Thanks

[1] http://nutch.apache.org/apidocs-1.4/index.html
[2] https://issues.apache.org/jira/browse/NUTCH-1218

-- 
Lewis

Re: Improving API Java Documentation

["Mattmann, Chris A (388J)" <ch...@jpl.nasa.gov>]

Hi Lewis,

+1 from me to the update and to logging a JIRA issue. Always nice to see
an associated changelog entry for any (even non trivial) updates, short of 
typos and error corrections in docs/etc. Up to you though, since you're the one
doing the work :-)

Cheers,
Chris

On Dec 12, 2011, at 10:28 AM, Lewis John Mcgibbney wrote:

> Hi Guys,
> 
> Been doing some snooping around the code recently and think that the
> API documentation [1] could do with some improving in some areas,
> please see corresponding Jira issue [2]. A real minor discrepancy I've
> encountered early on is that the ${name} variable is set in
> default.properties as ${name} and in build.xml as ${Name}, this means
> that it is not recognized within the Javadocs [1]. I propose to change
> this to ${name}, and to additionally add a Capital to the variable
> value therefore making it Nutch? Any thoughts? Does this require a
> Jira to be logged as well?
> 
> Thanks
> 
> [1] http://nutch.apache.org/apidocs-1.4/index.html
> [2] https://issues.apache.org/jira/browse/NUTCH-1218
> 
> -- 
> Lewis


++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Senior Computer Scientist
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 171-266B, Mailstop: 171-246
Email: chris.a.mattmann@nasa.gov
WWW:   http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Adjunct Assistant Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++