You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-dev@hadoop.apache.org by "Owen O'Malley (JIRA)" <ji...@apache.org> on 2006/07/28 22:27:13 UTC

[jira] Created: (HADOOP-399) the javadoc currently generates lot of warnings about bad fields

the javadoc currently generates lot of warnings about bad fields
----------------------------------------------------------------

                 Key: HADOOP-399
                 URL: http://issues.apache.org/jira/browse/HADOOP-399
             Project: Hadoop
          Issue Type: Bug
    Affects Versions: 0.4.0
            Reporter: Owen O'Malley
         Assigned To: Owen O'Malley
            Priority: Trivial


When building the "tar" target, I get the following warnings:

  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DFSck.java:475: warning - @return tag has no arguments.
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DatanodeProtocol.java:46: warning - Tag @link: reference not found: DatanodeRegistration
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DatanodeProtocol.java:46: warning - Tag @see: reference not found: FSNamesystem#registerDatanode(DatanodeRegistration)
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/BytesWritable.java:63: warning - @return tag has no arguments.
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/SequenceFile.java:252: warning - Tag @link: can't find Reader(FileSystem,Path,Configuration) in org.apache.hadoop.io.SequenceFile.Reader
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/SequenceFile.java:81: warning - Tag @link: can't find Writer(FileSystem,Path,Class,Class) in org.apache.hadoop.io.SequenceFile.Writer
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/Text.java:104: warning - @returns is an unknown tag.
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/Text.java:413: warning - @param argument "utf8:" is not a parameter name.
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/WritableUtils.java:338: warning - @param argument "i:" is not a parameter name.
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/mapred/JobConf.java:77: warning - @param argument "conf" is not a parameter name.
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/ExampleDriver.java:29: warning - Tag @author cannot be used in method documentation.  It can only be used in the following types of documentation: overview, package, class/interface.
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/ExampleDriver.java:29: warning - @date is an unknown tag.
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/PiBenchmark.java:62: warning - @param argument "value" is not a parameter name.
  [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/PiBenchmark.java:106: warning - @ is an unknown tag.


-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (HADOOP-399) the javadoc currently generates lot of warnings about bad fields

Posted by "Doug Cutting (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/HADOOP-399?page=all ]

Doug Cutting updated HADOOP-399:
--------------------------------

        Status: Resolved  (was: Patch Available)
    Resolution: Fixed

I just committed this.  Thanks, Nigel!

> the javadoc currently generates lot of warnings about bad fields
> ----------------------------------------------------------------
>
>                 Key: HADOOP-399
>                 URL: http://issues.apache.org/jira/browse/HADOOP-399
>             Project: Hadoop
>          Issue Type: Bug
>    Affects Versions: 0.4.0
>            Reporter: Owen O'Malley
>         Assigned To: Nigel Daley
>            Priority: Trivial
>             Fix For: 0.8.0
>
>         Attachments: javadoc-fixes.patch
>
>
> When building the "tar" target, I get the following warnings:
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DFSck.java:475: warning - @return tag has no arguments.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DatanodeProtocol.java:46: warning - Tag @link: reference not found: DatanodeRegistration
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DatanodeProtocol.java:46: warning - Tag @see: reference not found: FSNamesystem#registerDatanode(DatanodeRegistration)
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/BytesWritable.java:63: warning - @return tag has no arguments.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/SequenceFile.java:252: warning - Tag @link: can't find Reader(FileSystem,Path,Configuration) in org.apache.hadoop.io.SequenceFile.Reader
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/SequenceFile.java:81: warning - Tag @link: can't find Writer(FileSystem,Path,Class,Class) in org.apache.hadoop.io.SequenceFile.Writer
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/Text.java:104: warning - @returns is an unknown tag.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/Text.java:413: warning - @param argument "utf8:" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/WritableUtils.java:338: warning - @param argument "i:" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/mapred/JobConf.java:77: warning - @param argument "conf" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/ExampleDriver.java:29: warning - Tag @author cannot be used in method documentation.  It can only be used in the following types of documentation: overview, package, class/interface.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/ExampleDriver.java:29: warning - @date is an unknown tag.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/PiBenchmark.java:62: warning - @param argument "value" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/PiBenchmark.java:106: warning - @ is an unknown tag.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (HADOOP-399) the javadoc currently generates lot of warnings about bad fields

Posted by "Nigel Daley (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/HADOOP-399?page=all ]

Nigel Daley updated HADOOP-399:
-------------------------------

           Status: Patch Available  (was: Open)
    Fix Version/s: 0.8.0

This patch fixes all the javadoc warnings.  Before committing any new patches, please ensure your patch doesn't generate any javadoc warnings. 

This patch touches a large number of files, specifically these files:

src/examples/org/apache/hadoop/examples/ExampleDriver.java
src/examples/org/apache/hadoop/examples/PiBenchmark.java
src/java/org/apache/hadoop/conf/Configuration.java
src/java/org/apache/hadoop/dfs/DFSShell.java
src/java/org/apache/hadoop/dfs/DFSck.java
src/java/org/apache/hadoop/dfs/DatanodeProtocol.java
src/java/org/apache/hadoop/dfs/DistributedFileSystem.java
src/java/org/apache/hadoop/dfs/NamenodeFsck.java
src/java/org/apache/hadoop/fs/FileSystem.java
src/java/org/apache/hadoop/fs/Path.java
src/java/org/apache/hadoop/io/BytesWritable.java
src/java/org/apache/hadoop/io/SequenceFile.java
src/java/org/apache/hadoop/io/Text.java
src/java/org/apache/hadoop/io/WritableUtils.java
src/java/org/apache/hadoop/io/compress/CompressionInputStream.java
src/java/org/apache/hadoop/mapred/FileSplit.java
src/java/org/apache/hadoop/mapred/JobConf.java
src/java/org/apache/hadoop/mapred/JobHistory.java
src/java/org/apache/hadoop/mapred/SequenceFileInputFilter.java
src/java/org/apache/hadoop/mapred/StatusHttpServer.java
src/java/org/apache/hadoop/mapred/TaskTracker.java
src/java/org/apache/hadoop/util/ReflectionUtils.java
src/java/org/apache/hadoop/util/StringUtils.java
src/java/overview.html
src/test/org/apache/hadoop/mapred/EmptyInputFormat.java


> the javadoc currently generates lot of warnings about bad fields
> ----------------------------------------------------------------
>
>                 Key: HADOOP-399
>                 URL: http://issues.apache.org/jira/browse/HADOOP-399
>             Project: Hadoop
>          Issue Type: Bug
>    Affects Versions: 0.4.0
>            Reporter: Owen O'Malley
>         Assigned To: Nigel Daley
>            Priority: Trivial
>             Fix For: 0.8.0
>
>         Attachments: javadoc-fixes.patch
>
>
> When building the "tar" target, I get the following warnings:
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DFSck.java:475: warning - @return tag has no arguments.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DatanodeProtocol.java:46: warning - Tag @link: reference not found: DatanodeRegistration
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DatanodeProtocol.java:46: warning - Tag @see: reference not found: FSNamesystem#registerDatanode(DatanodeRegistration)
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/BytesWritable.java:63: warning - @return tag has no arguments.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/SequenceFile.java:252: warning - Tag @link: can't find Reader(FileSystem,Path,Configuration) in org.apache.hadoop.io.SequenceFile.Reader
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/SequenceFile.java:81: warning - Tag @link: can't find Writer(FileSystem,Path,Class,Class) in org.apache.hadoop.io.SequenceFile.Writer
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/Text.java:104: warning - @returns is an unknown tag.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/Text.java:413: warning - @param argument "utf8:" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/WritableUtils.java:338: warning - @param argument "i:" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/mapred/JobConf.java:77: warning - @param argument "conf" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/ExampleDriver.java:29: warning - Tag @author cannot be used in method documentation.  It can only be used in the following types of documentation: overview, package, class/interface.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/ExampleDriver.java:29: warning - @date is an unknown tag.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/PiBenchmark.java:62: warning - @param argument "value" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/PiBenchmark.java:106: warning - @ is an unknown tag.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Assigned: (HADOOP-399) the javadoc currently generates lot of warnings about bad fields

Posted by "Nigel Daley (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/HADOOP-399?page=all ]

Nigel Daley reassigned HADOOP-399:
----------------------------------

    Assignee: Nigel Daley  (was: Owen O'Malley)

> the javadoc currently generates lot of warnings about bad fields
> ----------------------------------------------------------------
>
>                 Key: HADOOP-399
>                 URL: http://issues.apache.org/jira/browse/HADOOP-399
>             Project: Hadoop
>          Issue Type: Bug
>    Affects Versions: 0.4.0
>            Reporter: Owen O'Malley
>         Assigned To: Nigel Daley
>            Priority: Trivial
>         Attachments: javadoc-fixes.patch
>
>
> When building the "tar" target, I get the following warnings:
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DFSck.java:475: warning - @return tag has no arguments.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DatanodeProtocol.java:46: warning - Tag @link: reference not found: DatanodeRegistration
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DatanodeProtocol.java:46: warning - Tag @see: reference not found: FSNamesystem#registerDatanode(DatanodeRegistration)
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/BytesWritable.java:63: warning - @return tag has no arguments.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/SequenceFile.java:252: warning - Tag @link: can't find Reader(FileSystem,Path,Configuration) in org.apache.hadoop.io.SequenceFile.Reader
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/SequenceFile.java:81: warning - Tag @link: can't find Writer(FileSystem,Path,Class,Class) in org.apache.hadoop.io.SequenceFile.Writer
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/Text.java:104: warning - @returns is an unknown tag.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/Text.java:413: warning - @param argument "utf8:" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/WritableUtils.java:338: warning - @param argument "i:" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/mapred/JobConf.java:77: warning - @param argument "conf" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/ExampleDriver.java:29: warning - Tag @author cannot be used in method documentation.  It can only be used in the following types of documentation: overview, package, class/interface.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/ExampleDriver.java:29: warning - @date is an unknown tag.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/PiBenchmark.java:62: warning - @param argument "value" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/PiBenchmark.java:106: warning - @ is an unknown tag.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (HADOOP-399) the javadoc currently generates lot of warnings about bad fields

Posted by "Nigel Daley (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/HADOOP-399?page=all ]

Nigel Daley updated HADOOP-399:
-------------------------------

    Attachment: javadoc-fixes.patch

> the javadoc currently generates lot of warnings about bad fields
> ----------------------------------------------------------------
>
>                 Key: HADOOP-399
>                 URL: http://issues.apache.org/jira/browse/HADOOP-399
>             Project: Hadoop
>          Issue Type: Bug
>    Affects Versions: 0.4.0
>            Reporter: Owen O'Malley
>         Assigned To: Nigel Daley
>            Priority: Trivial
>         Attachments: javadoc-fixes.patch
>
>
> When building the "tar" target, I get the following warnings:
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DFSck.java:475: warning - @return tag has no arguments.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DatanodeProtocol.java:46: warning - Tag @link: reference not found: DatanodeRegistration
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/dfs/DatanodeProtocol.java:46: warning - Tag @see: reference not found: FSNamesystem#registerDatanode(DatanodeRegistration)
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/BytesWritable.java:63: warning - @return tag has no arguments.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/SequenceFile.java:252: warning - Tag @link: can't find Reader(FileSystem,Path,Configuration) in org.apache.hadoop.io.SequenceFile.Reader
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/SequenceFile.java:81: warning - Tag @link: can't find Writer(FileSystem,Path,Class,Class) in org.apache.hadoop.io.SequenceFile.Writer
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/Text.java:104: warning - @returns is an unknown tag.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/Text.java:413: warning - @param argument "utf8:" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/io/WritableUtils.java:338: warning - @param argument "i:" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/java/org/apache/hadoop/mapred/JobConf.java:77: warning - @param argument "conf" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/ExampleDriver.java:29: warning - Tag @author cannot be used in method documentation.  It can only be used in the following types of documentation: overview, package, class/interface.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/ExampleDriver.java:29: warning - @date is an unknown tag.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/PiBenchmark.java:62: warning - @param argument "value" is not a parameter name.
>   [javadoc] /home/oom/work/eclipse/hadoop-trunk/src/examples/org/apache/hadoop/examples/PiBenchmark.java:106: warning - @ is an unknown tag.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira