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

stddoclet: -linkoffline mistakenly inserts '\' instead of '/' in URL on Windows

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P3 P3
    • 1.4.0
    • 1.2.0
    • tools
    • beta
    • sparc
    • solaris_2.6

      I am observing a behavior in JavaDoc which I would classify as a bug.
      However, it might be that I'm missing something.

      I'm using -linkoffline option for enabling links from my documentation to the
      standard JDK classes. This option accepts extdocURL parameter which it uses
      as a prefix for making hyperlinks to the external documentation. After that a
      pathname separator is placed and a path to the specific HTML page. I'm
      running JavaDoc on Windows NT. Because of this (I guess) JavaDoc uses
      backslash (\) as a separator between the basepath to the ext docs and the
      tail.

      For example, if my class com.mycompany.mypackage.MyClass extends
      javax.swing.JTable, and assuming I run javadoc -linkoffline ../JDK/docs/api
      /JDK/docs/api, the result would be:
      ../../../../JDK/docs/api\javax/swing/JTable.html Pay attention to the
      backslash in the middle. Everything would be nice, were Windows NT the only
      platform in the world. This is, however, not true. For reasons, not relevant
      to this discussion, I'm using Apache on Unix as a Web server for viewing the
      generated documentation. Since use of backslash is not standard in HTML,
      links of this kind do not work. Would be happy to hear a possible workaround.

      Technical info:

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

      javadoc -d \Qbuild\doc -sourcepath \Q
           -classpath \Qbuild\class
           -linkoffline ../JDK/docs/api /JDK/docs/api <package-name>
      (the command is split into lines for readability)

      Thank you for your attention.

            jhosunw Jamie Ho (Inactive)
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: