Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-6413576

Fix javadoc warnings in public source files

XMLWordPrintable

    • b89
    • generic
    • generic

      When building javadoc documentation for the JSR-198, JSR-269, and Tree API classes, the following fifty-four warnings are reported:

      Standard Doclet version 1.6.0-beta2
      Building tree for all the packages and classes...
      com/sun/source/util/TreePath.java:28: warning - @returns is an unknown tag.
      com/sun/source/util/TreePath.java:36: warning - @returns is an unknown tag.
      javax/annotation/processing/ProcessingEnvironment.java:29: warning - @Note is an unknown tag.
      javax/annotation/processing/Processor.java:77: warning - @Note is an unknown tag.
      javax/annotation/processing/Processor.java:77: warning - @ToDo is an unknown tag.
      javax/annotation/processing/Processor.java:77: warning - @ToDo is an unknown tag.
      javax/annotation/processing/Processor.java:111: warning - @ToDo is an unknown tag.
      javax/annotation/processing/RoundEnvironment.java:68: warning - @ToDo is an unknown tag.
      javax/annotation/processing/RoundEnvironment.java:68: warning - @ToDo is an unknown tag.
      javax/annotation/processing/SupportedSourceVersion.java:34: warning - @ToDo is an unknown tag.
      javax/annotation/processing/SupportedSourceVersion.java:34: warning - @ToDo is an unknown tag.
      javax/lang/model/SourceVersion.java:30: warning - @ToDo is an unknown tag.
      javax/lang/model/SourceVersion.java:30: warning - @Note is an unknown tag.
      javax/lang/model/SourceVersion.java:143: warning - @ToDo is an unknown tag.
      javax/lang/model/element/Element.java:45: warning - @ToDo is an unknown tag.
      javax/lang/model/element/Element.java:45: warning - @ToDo is an unknown tag.
      javax/lang/model/element/Element.java:65: warning - @ToDo is an unknown tag.
      javax/lang/model/element/Element.java:73: warning - @ToDo is an unknown tag.
      javax/lang/model/element/Element.java:124: warning - @ToDo is an unknown tag.
      javax/lang/model/element/Element.java:150: warning - @ToDo is an unknown tag.
      javax/lang/model/element/Element.java:180: warning - @ToDo is an unknown tag.
      javax/lang/model/element/Element.java:180: warning - @ToDo is an unknown tag.
      javax/lang/model/element/Element.java:180: warning - @ToDo is an unknown tag.
      javax/lang/model/element/ElementKind.java:18: warning - @ToDo is an unknown tag.
      javax/lang/model/element/NestingKind.java:18: warning - @ToDo is an unknown tag.
      javax/lang/model/element/TypeParameterElement.java:45: warning - @Note is an unknown tag.
      javax/lang/model/element/VariableElement.java:38: warning - @ToDo is an unknown tag.
      javax/lang/model/type/DeclaredType.java:54: warning - @ToDo is an unknown tag.
      javax/lang/model/type/TypeMirror.java:58: warning - @ToDo is an unknown tag.
      javax/lang/model/type/TypeMirror.java:90: warning - @ToDo is an unknown tag.
      javax/lang/model/util/AbstractTypeVisitor6.java:44: warning - @ToDo is an unknown tag.
      javax/lang/model/util/ElementFilter.java:46: warning - @Note is an unknown tag.
      javax/lang/model/util/ElementFilter.java:46: warning - @ToDo is an unknown tag.
      javax/lang/model/util/ElementKindVisitor6.java:63: warning - @ToDo is an unknown tag.
      javax/lang/model/util/ElementKindVisitor6.java:63: warning - @ToDo is an unknown tag.
      javax/lang/model/util/Elements.java:37: warning - @ToDo is an unknown tag.
      javax/lang/model/util/Elements.java:120: warning - @ToDo is an unknown tag.
      javax/lang/model/util/ElementScanner6.java:76: warning - @ToDo is an unknown tag.
      javax/lang/model/util/ElementScanner6.java:76: warning - @Note is an unknown tag.
      javax/lang/model/util/ElementScanner6.java:157: warning - @ToDo is an unknown tag.
      javax/lang/model/util/ElementScanner6.java:168: warning - @Note is an unknown tag.
      javax/lang/model/util/ElementScanner6.java:179: warning - @ToDo is an unknown tag.
      javax/lang/model/util/SimpleElementVisitor6.java:58: warning - @ToDo is an unknown tag.
      javax/lang/model/util/SimpleTypeVisitor6.java:57: warning - @ToDo is an unknown tag.
      javax/lang/model/util/TypeKindVisitor6.java:61: warning - @ToDo is an unknown tag.
      javax/lang/model/util/Types.java:57: warning - @jls3 is an unknown tag.
      javax/lang/model/util/Types.java:68: warning - @jls3 is an unknown tag.
      javax/lang/model/util/Types.java:78: warning - @jls3 is an unknown tag.
      javax/lang/model/util/Types.java:90: warning - @jls3 is an unknown tag.
      javax/lang/model/util/Types.java:108: warning - @jls3 is an unknown tag.
      javax/lang/model/util/Types.java:118: warning - @jls3 is an unknown tag.
      javax/lang/model/util/Types.java:129: warning - @jls3 is an unknown tag.
      javax/lang/model/util/Types.java:129: warning - @ToDo is an unknown tag.
      javax/lang/model/util/Types.java:138: warning - @jls3 is an unknown tag.

      In addition, another documentation generating tool we use reports this error:

      javax/annotation/processing/package-summary.html:122:59: spaces in URIs should be encoded as "%20": javax/annotation/processing/Processor.html#process(java.util.Set, javax.annotation.processing.RoundEnvironment)

            jjg Jonathan Gibbons
            tballsunw Tom Ball (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: