Uploaded image for project: 'Code Tools'
  1. Code Tools
  2. CODETOOLS-7901923

jtharness docs has lots of doclint errors

XMLWordPrintable

      Reported by the Adopt OpenJDK group:

      Building JT Harness with JDK 8 fails with lots of doclint problems. The following is a small sample from the beginning of their build log.

        [javadoc] Generating Javadoc
        [javadoc] Javadoc execution
        [javadoc] Loading source files for package com.sun.interview...
        [javadoc] Loading source files for package com.sun.javatest...
        [javadoc] Loading source files for package com.sun.javatest.exec...
        [javadoc] Loading source files for package com.sun.javatest.finder...
        [javadoc] Loading source files for package com.sun.javatest.interview...
        [javadoc] Loading source files for package com.sun.javatest.lib...
        [javadoc] Loading source files for package com.sun.javatest.report...
        [javadoc] Loading source files for package com.sun.javatest.tool...
        [javadoc] Loading source files for package com.sun.javatest.util...
        [javadoc] Constructing Javadoc information...
        [javadoc] Standard Doclet version 1.8.0_121
        [javadoc] Building tree for all the packages and classes...
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/CompositeQuestion.java:62: warning: no @param for id
        [javadoc] public abstract void setValue(String id, String s) throws Interview.Fault;
        [javadoc] ^
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/Help.java:65: warning: no @param for q
        [javadoc] public static ID getHelpID(Question q) {
        [javadoc] ^
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/Help.java:115: error: exception not thrown: com.sun.javatest.TestSuite.Fault
        [javadoc] * @throws TestSuite.Fault if there are problems opening any of the
        [javadoc] ^
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/Help.java:118: warning: no @param for ts
        [javadoc] public static HelpSet[] getAdditionalDocs(TestSuite ts) throws Help.Fault {
        [javadoc] ^
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/Help.java:118: warning: no @throws for com.sun.interview.Help.Fault
        [javadoc] public static HelpSet[] getAdditionalDocs(TestSuite ts) throws Help.Fault {
        [javadoc] ^
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/HelpSetFactory.java:50: warning: no @param for name
        [javadoc] public Object createHelpSetObject(String name, Class c) throws Interview.Fault;
        [javadoc] ^
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/HelpSetFactory.java:50: warning: no @param for c
        [javadoc] public Object createHelpSetObject(String name, Class c) throws Interview.Fault;
        [javadoc] ^
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/HelpSetFactory.java:50: warning: no @return
        [javadoc] public Object createHelpSetObject(String name, Class c) throws Interview.Fault;
        [javadoc] ^
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/HelpSetFactory.java:59: warning: no @param for name
        [javadoc] public Object createHelpSetObject(String name, File file) throws Interview.Fault;
        [javadoc] ^
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/HelpSetFactory.java:59: warning: no @param for file
        [javadoc] public Object createHelpSetObject(String name, File file) throws Interview.Fault;
        [javadoc] ^
        [javadoc] /scratch/jenkins/workspace/jtharness/src/com/sun/interview/HelpSetFactory.java:59: warning: no @return
        [javadoc] public Object createHelpSetObject(String name, File file) throws Interview.Fault;
        [javadoc] ^

            dbessono Dmitry Bessonov
            jjg Jonathan Gibbons
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: