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

javadoc has problems inheriting serial doc comments

XMLWordPrintable

      The attached file shows a case where a class wants to inherit the
      documentation for its serialized form from a parent class.

      Running the command:

          javadoc -d docs -package E.java

      generates the following exception (note that the command completes,
      but the HTML generated for the serial data is broken):

      Loading source file E.java...
      Constructing Javadoc information...
      Standard Doclet version 1.6.0-internal
      Building tree for all the packages and classes...
      Generating docs/E.html...
      Generating docs/E.F.html...
      Generating docs/E.G.html...
      Generating docs/E.H.html...
      Generating docs/package-frame.html...
      Generating docs/package-summary.html...
      Generating docs/package-tree.html...
      Generating docs/constant-values.html...
      Generating docs/serialized-form.html...
      E.java:26: warning - @inheritDoc used but writeObject(ObjectOutputStream) does not override or implement any method.
      java.lang.ClassCastException: com.sun.tools.doclets.internal.toolkit.taglets.SimpleTaglet cannot be cast to com.sun.tools.doclets.internal.toolkit.taglets.InheritableTaglet
      at com.sun.tools.doclets.internal.toolkit.taglets.InheritDocTaglet.retrieveInheritedDocumentation(InheritDocTaglet.java:108)
      at com.sun.tools.doclets.internal.toolkit.taglets.InheritDocTaglet.getTagletOutput(InheritDocTaglet.java:134)
      at com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter.getInlineTagOuput(TagletWriter.java:201)
      at com.sun.tools.doclets.formats.html.HtmlDocletWriter.commentTagsToString(HtmlDocletWriter.java:1446)
      at com.sun.tools.doclets.formats.html.TagletWriterImpl.simpleTagOutput(TagletWriterImpl.java:188)
      at com.sun.tools.doclets.internal.toolkit.taglets.SimpleTaglet.getTagletOutput(SimpleTaglet.java:197)
      at com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter.genTagOuput(TagletWriter.java:167)
      at com.sun.tools.doclets.formats.html.HtmlSerialMethodWriter.writeMemberTags(HtmlSerialMethodWriter.java:71)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.buildMethodTags(SerializedFormBuilder.java:338)
      at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
      at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
      at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
      at java.lang.reflect.Method.invoke(Method.java:589)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.invokeMethod(SerializedFormBuilder.java:131)
      at com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder.build(AbstractBuilder.java:90)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.buildMethodInfo(SerializedFormBuilder.java:357)
      at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
      at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
      at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
      at java.lang.reflect.Method.invoke(Method.java:589)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.invokeMethod(SerializedFormBuilder.java:131)
      at com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder.build(AbstractBuilder.java:90)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.buildSerializableMethods(SerializedFormBuilder.java:468)
      at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
      at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
      at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
      at java.lang.reflect.Method.invoke(Method.java:589)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.invokeMethod(SerializedFormBuilder.java:131)
      at com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder.build(AbstractBuilder.java:90)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.buildClassSerializedForm(SerializedFormBuilder.java:185)
      at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
      at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
      at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
      at java.lang.reflect.Method.invoke(Method.java:589)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.invokeMethod(SerializedFormBuilder.java:131)
      at com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder.build(AbstractBuilder.java:90)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.buildPackageSerializedForm(SerializedFormBuilder.java:167)
      at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
      at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
      at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
      at java.lang.reflect.Method.invoke(Method.java:589)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.invokeMethod(SerializedFormBuilder.java:131)
      at com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder.build(AbstractBuilder.java:90)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.buildSerializedFormSummaries(SerializedFormBuilder.java:148)
      at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
      at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
      at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
      at java.lang.reflect.Method.invoke(Method.java:589)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.invokeMethod(SerializedFormBuilder.java:131)
      at com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder.build(AbstractBuilder.java:90)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.buildSerializedForm(SerializedFormBuilder.java:116)
      at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
      at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
      at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
      at java.lang.reflect.Method.invoke(Method.java:589)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.invokeMethod(SerializedFormBuilder.java:131)
      at com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder.build(AbstractBuilder.java:90)
      at com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder.build(SerializedFormBuilder.java:101)
      at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.generateOtherFiles(AbstractDoclet.java:137)
      at com.sun.tools.doclets.formats.html.HtmlDoclet.generateOtherFiles(HtmlDoclet.java:66)
      at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:122)
      at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
      at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
      at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
      at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
      at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
      at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
      at java.lang.reflect.Method.invoke(Method.java:589)
      at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:215)
      at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:91)
      at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
      at com.sun.tools.javadoc.Start.begin(Start.java:128)
      at com.sun.tools.javadoc.Main.execute(Main.java:41)
      at com.sun.tools.javadoc.Main.main(Main.java:31)
      Building index for all the packages and classes...
      Generating docs/overview-tree.html...
      Generating docs/index-all.html...
      Generating docs/deprecated-list.html...
      Building index for all classes...
      Generating docs/allclasses-frame.html...
      Generating docs/allclasses-noframe.html...
      Generating docs/index.html...
      Generating docs/help-doc.html...
      Generating docs/stylesheet.css...
      1 warning

            Unassigned Unassigned
            flar Jim Graham
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Imported:
              Indexed: