JDK-4463460 : stddoclet: Javadoc warnings for main() method do not specify the enclosing clas
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.3.1
  • Priority: P4
  • Status: Closed
  • Resolution: Duplicate
  • OS: windows_2000
  • CPU: x86
  • Submitted: 2001-05-26
  • Updated: 2014-05-05
  • Resolved: 2001-05-29
Related Reports
Duplicate :  
Description

Name: bsC130419			Date: 05/25/2001


java version "1.3.0_02"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.3.0_02)
Java HotSpot(TM) Client VM (build 1.3.0_02, mixed mode)

Typically javadoc gives warnings messages that state the full classname from
which the warning originated, like:

javadoc: warning - Method suncertify.db.DataServer.getRecord
        documents that it throws java.io.IOException,
        but does not declare it.

However, when I run it over a class DataServer it gives this warning for the
main method, which doesnt not specify the enclosing class and thus makes it
very diffcult to locater the problem in a large codebase:

javadoc: warning - main: @param tag has no arguments.

The method javadoc showing the @param problem is:
    /**
     * Creates a data delegate, then DataServer, and exports to RMI registry.
     * @param
     */
    public static void main(String[] args) {
       etc, etc
    }
(Review ID: 124879) 
======================================================================

Comments
WORK AROUND Name: bsC130419 Date: 05/25/2001 Look for such warnings in any classes you know have main() methods. ======================================================================
11-06-2004

EVALUATION Will investigate and fix asap. jamie.ho@Eng 2001-05-25
25-05-2001

PUBLIC COMMENTS Will investigate and fix asap. jamie.ho@Eng 2001-05-25
25-05-2001