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

misleading example in javadoc man page

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P4 P4
    • 9
    • 8u60, 9
    • docs
    • None

      This was originally reported as https://bugzilla.redhat.com/show_bug.cgi?id=1113889

      From javadoc man page, section "JAVADOC OPTIONS", "-classpath":

      """
      For example, if you want to document com.mypackage, whose source files reside in the directory /home/user/src/com/mypackage, and if this package relies on a library in /home/user/lib, then you would use the following command:

          javadoc -sourcepath /home/user/lib -classpath /home/user/src com.mypackage
      """

      The last line should look like this:
      javadoc -sourcepath /home/user/src -classpath /home/user/lib com.mypackage

      This issue is present in both OpenJDK 8 and 9.

      The following files all seem to be affected by it:

      ./jdk/src/solaris/doc/sun/man/man1/ja/javadoc.1
      ./jdk/src/solaris/doc/sun/man/man1/javadoc.1
      ./jdk/src/linux/doc/man/ja/javadoc.1
      ./jdk/src/linux/doc/man/javadoc.1
      ./jdk/src/bsd/doc/man/javadoc.1

            schetan Shilpa Chetan
            omajid Omair Majid
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: