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

javadoc template: Keywords "synchronized" + "native" shouldn't appear in HTML si

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P2 P2
    • 1.2.0
    • 1.2.0
    • tools
    • 1.2beta2
    • sparc
    • solaris_2.5
    • Verified

      Javadoc tool should be modified so it does not print the keywords "synchronized"
      or "native" in the method signatures.

      This javadoc bug has a corollary doc bug 4078860, whereby the class and method descriptions should be beefed up, as follows.

      It's important for the developer to know whether it's safe for multiple threads
      to operate on an object concurrently, However, this synchronization can be
      done either in public methods or in private methods, and the Java Platform API
      spec should not declare one to be preferred over the other. A licensee should
      be able to achieve synchronization internally if they wish.

      Therefore, the general description of a class should mention whether the class is thread-safe or not. Individual method descriptions that are exceptions should mention that they are exceptions.

            rfield Robert Field (Inactive)
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: