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

stddoclet: Exclude classes/members (e.g. RMI stubs and skeletons) @docset tag

    XMLWordPrintable

    Details

    • Subcomponent:
    • CPU:
      generic, x86, sparc
    • OS:
      generic, other, solaris_2.5.1, windows_95, windows_nt

      Description

      This is a feature to enable developers to skip classes and packages when
      running javadoc.

      People might want gradations of exclusion --
      they might want to exclude a class for expert developers (service providers),
      but include it for normal developers. If the tag can be named, it would be
      possible to include all classes with a certain name: "@exclude licensee"
      would be excluded by default (with or without the name "licensee",
      but could be overridden with "javadoc -include licensee".

      This should work at the member level, class level and package level.

      One developer suggests @publicAPI rather than @exclude. @publicAPI
      would mark API that should be documented for external use (and in
      his case, not be obfuscated). -public would be relegated to
      internal documentation only. Reasons:

        1) The methods, fields and classes that are API public are most
           likely to have doc comments already, the @exclude would need
           to be added to elements devoid of doc comments.
        2) The API public elements are usually fewer in number than
           the 'public' access symbols that would require '@exclude'

      --------------------------------------------------------------
      From another submitter:

      One of the reasons we find it useful to exclude a class is that we have
      a class in the package that can be used by support in the field but is
      of no use to the programmer using the public api of the product in that
      same package.

      If we move this class to a sub package, it is now outside the package it wants
      to be a part of for package private functionality.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              bpatel Bhavesh Patel (Inactive)
              Reporter:
              karnoldsunw Kenneth Arnold (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: