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

Javadoc needs a standard thread safety tag

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Won't Fix
    • P4
    • None
    • 1.4.0, 1.4.1
    • tools
    • x86
    • windows_2000, windows_xp

    Description

      Name: rmT116609 Date: 08/04/2002

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

      DESCRIPTION OF THE PROBLEM :
      It is very hard to hunt for thread safety information in a javadoc for a class in non-standard places. Is the thread safety documented, if yes, where, etc... Javadoc should have a tag for that, something like @threadsafety, which would place the comment in some standard place. If a class does not have a @threadsafety tag, then a default such as "This class is thread safe" should be placed in the thread safety section of the javadoc.

      Description from duplicate RFE 4743384:
      Frequently javadocs omit information regarding thread
      safety. I believe thread safety would be documented more
      consistently if tags were available to explicitly mark the
      thread safety of classes.


      (Review ID: 160295)
      ======================================================================

      Attachments

        Issue Links

          Activity

            People

              bpatel Bhavesh Patel (Inactive)
              rmandalasunw Ranjith Mandala (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: