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

Javadoc to access API comments from classes without including in output

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Duplicate
    • Icon: P4 P4
    • None
    • 1.4.0
    • tools

      Name: gm110360 Date: 05/28/2002

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

      A DESCRIPTION OF THE PROBLEM :
      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.

      This bug can be reproduced always.
      (Review ID: 147154)
      ======================================================================

            Unassigned Unassigned
            gmanwanisunw Girish Manwani (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: