Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4075128
Votes 12
Synopsis Exclude/hide members of the Java source
Category doclet:tbd
Reported Against 1.1.2 , 1.1.3
Release Fixed
State 11-Closed, duplicate of 4058216, request for enhancement
Priority: 5-Very Low
Related Bugs 4058216
Submit Date 28-AUG-1997
Description





When writing interfaces it is required that the
implementing classes declare the methods from the
interface as 'public'.
When generating the documentation the methods of
the implementing classes appear as well. This is
something I don't want since I already documented
the interface documentation already to describe
the methods. As JavaDoc acts now the package
documentation becomes rather messy.
I would be nice if JavaDoc could exclude parts
of the source. e.g:

/* @javadoc off */

<excluded java source>

/* @javadoc on  */

======================================================================
Work Around





======================================================================
Evaluation
Handling of methods for interfaces is actually a separate issue, created 
bug #4095293 for this.

A way to hide methods from javadoc would be useful as well.  Though it should
not be modal like that proposed but rather '@hide' on those entries that should
be hidden.
  xxxxx@xxxxx   1997-11-25

Am closing what's remaining of this as a dupe of 4058216, which also
recommends the @hide tag. 
  xxxxx@xxxxx   1998-04-13
Comments
  
  Include a link with my name & email   

Submitted On 02-JAN-1998
tbaldridge
This is a vary important feature!  I now have a huge last-minute mess on my
hands because there is no way to exclude uncommented APIs



PLEASE NOTE: JDK6 is formerly known as Project Mustang