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

javadoc is reporting errors when classpath jar files have package.html files

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P2 P2
    • 1.4.2
    • 1.4.0, 1.4.1
    • tools
    • mantis
    • x86
    • linux



      Name: gm110360 Date: 06/04/2002


      FULL PRODUCT VERSION :
      java version "1.4.0"
      Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.0-b92)
      Java HotSpot(TM) Client VM (build 1.4.0-b92, mixed mode)


      FULL OPERATING SYSTEM VERSION :
      generic

      ADDITIONAL OPERATING SYSTEMS :

      Linux draught.bbn.com 2.4.19-pre8 #1 SMP Tue May 21 14:23:08
      EDT 2002 i686 unknown

      A DESCRIPTION OF THE PROBLEM :

      javadoc is reporting bogus errors when classpath-referenced jar files have package.html files.

      I've used jar to package a single set of files as examples for all the associated bug reports.When running javadoc in a large autobuild process, I see a number of messages like:
        server.jar: Body tag missing from HTML
        1 error

      On the assumption that there was something wrong with the
      jar file, I tried:
        A. removing all html files from the jar file: there were
      two "package.html" files. The result is "bar.jar"
        B. leaving exactly one "package.html" file with only
      simplified content in the jar file. The result is "foo.jar"

        Interestingly, in case A (no package.html files), the error
      disappears but in case B (a single package.html with
      standard content), the error is back. In case B, it doesn't
      even matter what the content of the file is - the existence
      of the complained about body tags doesn't effect the message
      at all - I even tried the canonical package.html from the
      javadoc documentation to no avail.

      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      [I attached javadocbug.jar to this bug report - dkramer]
      The minimal examples may be found at:
      http://www.alpine.bbn.com/~mthome/javadocbug.jar
      grab the the above file and unpack it into a clean directory
      of your choosing. It contains some .java files and some
      .jar files used in the various "steps to reproduce" sections.
      % cd /tmp/foo
      % jar xf /tmp/javadocbug.jar
      % mkdir api
      # test 1
      % javadoc -classpath server.jar -quiet -d api -sourcepath src org.cougaar
      Loading source files for package org.cougaar...
      Constructing Javadoc information...
      server.jar: Body tag missing from HTML
      1 error

      # test 4 case A (tests 2,3 is not relevant for this report)
      % rm -rf api; mkdir api
      % javadoc -classpath bar.jar -quiet -d api -sourcepath src org.cougaar
      Loading source files for package org.cougaar...
      Constructing Javadoc information...

      # test 4 case B
      % rm -rf api; mkdir api
      % javadoc -classpath foo.jar -quiet -d api -sourcepath src org.cougaar
      Loading source files for package org.cougaar...
      Constructing Javadoc information...
      foo.jar: Body tag missing from HTML
      1 error
      %


      EXPECTED VERSUS ACTUAL BEHAVIOR :
      Actual:
      see above

      Expected:
      test 4B should complete without error - there is nothing
      wrong with the package.html file, even if were required by
      this javadoc run (and it isn't).

      ERROR MESSAGES/STACK TRACES THAT OCCUR :
      server.jar: Body tag missing from HTML

      This bug can be reproduced always.

      ---------- BEGIN SOURCE ----------
      not relevant. The source code used in the example can be anything at all to
      generate the same error.
      ---------- END SOURCE ----------
      (Review ID: 146962)
      ======================================================================

            jhosunw Jamie Ho (Inactive)
            gmanwanisunw Girish Manwani (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: