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

stddoclet: Add @protected, @package and @private tags for hiding public members

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Won't Fix
    • P5
    • None
    • 1.1.8
    • tools

    Description

      Name: vi73552 Date: 03/11/99

      I was having some trouble with documenting callbacks on some of my objects.
      For our callbacks, we have been using generic interface classes (whose methods must be public).
      Unfortunately, we wish to have such information included only when related protected or private methods are documented, but since the
      callback will always be documented regardless.

      I was wanting to suggest the addition of some javadoc tags such that
      a method's private/protected/public keywords could (for documentation
      purposes only) be overidden by the comment.
      For example, (using @private and @protected)

      /** @protected */
      public void foo() {}

      /** @private */
      public void foo2() {}

      would cause foo() to be documented as a protected method.
      and would cause foo2() to be documented as a private method.

      In our particular case, we have:
      public class IInterface {
         public void foobar();
      }

      class fudd extends IInterface {
      private void foo() {.... indirectly uses IInterface as a callback...}
      public void foobar() {}
      }

      When we generate the public documentation, we have a method which
      we would prefer to only have documented with its private counterpart,
      but instead (confusingly) appears alone whenever we generate the "public" documentation
      (Review ID: 55371)
      ======================================================================

      Attachments

        Activity

          People

            bpatel Bhavesh Patel (Inactive)
            vasya Vassili Igouchkine (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: