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

stddoclet: Consider making @internal a standard tag

    XMLWordPrintable

    Details

      Description

      Name: dgC58589 Date: 01/08/98

      It would be terrifically handy to use doc comments not only to produce API documentation, but also to maintain internal design documentation inline (so it is under revision control, and would have a shot at getting updated when the code is changed). Also, one might want to maintain things like TODO lists in API documentation that is only seen in house.

      It would be helpful to have a scheme to allow tagged comments (or parts of tagged comments) to only be processed if some "internal" option is given on the javadoc command line. This could be implemented with a new @internal tag, or could be linked to the current idea of privacy. (A doc comment on a public method that included a @private tag would not be processed unless the "-private" option is used on the javadoc command line.)

      Microsoft's autoduck has some ability to tag comments as "internal only" We have used that to integrate our design documentation with our external documentation (and the source code).

      Thanks.

      David Dhuyvetter
      (Review ID: 22867)
      ======================================================================

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              bpatel Bhavesh Patel (Inactive)
              Reporter:
              dgrahamcsunw David Graham-cumming (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: