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

Warn when doc comment is ignored

XMLWordPrintable

    • Fix Understood

      It happens from time to time that someone mistakenly inserts an import
      statement between the class comment and the class declaration,
      with the result that no class comment is generated.

      People get baffled by this (and in large documents, I'll bet
      they don't always notice the comments are missing). Could
      javadoc please emit a warning in this case.

      /**
       * This is the class comment
       * @author Biz
       * @version 04/02/2001
       */

      import java.io.*;

      public class MyClass {
      }

            jlahoda Jan Lahoda
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Imported:
              Indexed: