[jira] Resolved: (NUTCH-390) Javadoc warnings

["Chris A. Mattmann (JIRA)" <ji...@apache.org>]

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

Chris A. Mattmann resolved NUTCH-390.
-------------------------------------

       Resolution: Fixed
    Fix Version/s: 0.9.0

I've fixed this issue in the trunk. I had to modify the existing commons-logging-1.4.0 and 1.3.0 jars within nutch/lib and within nutch/src/plugin/ontology/lib. Turns out that if you include the package.html file within the jar file, Javadoc gets confused as to which one it should use. That was the only real gotcha. This should address *all* the javadoc warnings that were being generated.

> Javadoc warnings
> ----------------
>
>                 Key: NUTCH-390
>                 URL: https://issues.apache.org/jira/browse/NUTCH-390
>             Project: Nutch
>          Issue Type: Bug
>    Affects Versions: 0.9.0
>         Environment: Linux Fedora
>            Reporter: nutch.newbie
>         Assigned To: Chris A. Mattmann
>            Priority: Trivial
>             Fix For: 0.9.0
>
>
> Warnings aren't so good even if it build's successfully.
>   [javadoc] Building tree for all the packages and classes...
>   [javadoc] /usr/local/src/nutch-0.9/src/java/org/apache/nutch/net/URLNormalizers.java:74: warning - Tag @link: reference not found: org.apache.nutch.net.urlnormalizer.pass.PassURLNormalizer
>   [javadoc] /usr/local/src/nutch-0.9/src/java/org/apache/nutch/net/URLNormalizers.java:273: warning - @return tag has no arguments.
>   [javadoc] /usr/local/src/nutch-0.9/src/java/org/apache/nutch/plugin/PluginManifestParser.java:73: warning - @return tag has no arguments.
>   [javadoc] /usr/local/src/nutch-0.9/src/java/org/apache/nutch/protocol/ProtocolFactory.java:37: warning - Missing closing '}' character for inline tag: "{@link Protocol#X_POINT_ID)."
>   [javadoc] /usr/local/src/nutch-0.9/src/java/org/apache/nutch/protocol/ProtocolFactory.java:64: warning - @return tag has no arguments.
>   [javadoc] /usr/local/src/nutch-0.9/src/java/org/apache/nutch/scoring/ScoringFilter.java:139: warning - Tag @param cannot be used in inline documentation.  It can only be used in the following types of documentation: class/interface, constructor, method.
>   [javadoc] /usr/local/src/nutch-0.9/src/java/org/apache/nutch/scoring/ScoringFilter.java:139: warning - Tag @param cannot be used in inline documentation.  It can only be used in the following types of documentation: class/interface, constructor, method.
>   [javadoc] /usr/local/src/nutch-0.9/src/java/org/apache/nutch/util/DomUtil.java:51: warning - @return tag has no arguments.
>   [javadoc] /usr/local/src/nutch-0.9/src/java/org/apache/nutch/scoring/ScoringFilter.java:139: warning - Tag @param cannot be used in inline documentation.  It can only be used in the following types of documentation: class/interface, constructor, method.
>   [javadoc] Building index for all the packages and classes...
>   [javadoc] Building index for all classes...
>   [javadoc] Generating /usr/local/src/nutch-0.9/build/docs/api/stylesheet.css...
>   [javadoc] 10 warnings
>      [copy] Copying 1 file to /usr/local/src/nutch-0.9/build/docs/api/org/apache/nutch/plugin/doc-files

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.