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

stddoclet: @serial comment for field appears only on serialized form page

XMLWordPrintable

      Name: clC74495 Date: 09/11/98

      If the documentation for a field does not use the
      @serial tag, javadoc will issue a warning, but
      still use that field's comment on both the class
      page and the "serialized form" page.

      However, if the @serial tag IS used, that
      tag's comment will show up only on the
      "serialized form" page. We would prefer
      that it show up on both the class page
      and the "serialized form" page.

      This is especially annoying when documenting
      public and protected fields, since the
      documentation in the field comment and @serial
      tag is often the same.

      See the "Work Around" for an illustration.

      (Review ID: 38665)
      ======================================================================

            jjg Jonathan Gibbons
            clucasius Carlos Lucasius (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: