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

Want to inherit documentation from classes not being documented

XMLWordPrintable

      Name: nt126004 Date: 06/24/2002

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

      A DESCRIPTION OF THE PROBLEM :
      Enhancement to the javadoc command: A new option to force
      all source files found on -sourcepath to be loaded for
      inheriting documentation, or an option for specifying
      packages or classes you want to be loaded only for
      inheriting documentation. (suggestion from Douglas Kramer)

      The situation: I generate documentation for many related
      packages. There is a "core" package holding base classes
      and interfaces extended or implemented in the other
      packages. These other packages are not subpackages of this
      core package.

      In the "non-core" packages, I would like to be able to
      inherit the comments of my base classes, without generating
      the doc of the core package (that is, without including the
      core package in the command line).

      A similar concept is described in the documentation of the
      sourcepath option. The doc says: "Note that this option is
      not only used to locate the source files being documented,
      but also to find source files that are not being documented
      but whose comments are inherited by the source files being
      documented. "

      For the time being, I will manually duplicate the comments
      from the base class to the implemented class, since I want
      the Javadoc to be documented independently for each package.

      (Review ID: 153567)
      ======================================================================
      Description from duplicate 4692678:

      I would like to see an enhancement to Javadoc, so that you
      can specify that classes that inherit standard library
      classes automatically inherit their Javadoc comments too,
      but without necessarily including the classes in the
      javadoc output.

      See discussion of the issue at
      http://forum.java.sun.com/thread.jsp?forum=41&thread=257634
      for an example with javax.naming.Context.

      If there were an option -inheritapipath where you could
      specify a directory or the src.zip file, then I would not
      need to manually add each overridden interface or class.

      Alternatively a general option -inheritdocpath would
      provide access to any source files (not just J2 API files)
      and would inherit their javadoc comments without including
      them in the javadoc run.

            jhosunw Jamie Ho (Inactive)
            nthompsosunw Nathanael Thompson (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: