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: 4290079
Votes 0
Synopsis stddoclet: Automate Serialized Form page for @serial include and exclude tags
Category doclet:tbd
Reported Against 1.2
Release Fixed 1.4(merlin-beta)
State 10-Fix Delivered, request for enhancement
Priority: 4-Low
Related Bugs
Submit Date 10-NOV-1999
Description
This bug has been fixed.Javadoc running on the Java 2 SDK is not currently fully automated.  
The one manual step is the creation of the Serialized Form page, 
which is extremely complex and takes Doug about three full days 
for each release.  Josh and I have determined that we can fully 
automate this with the addition of the "include" and "exclude" 
arguments to the @serial tag.  The reasons behind these special 
cases are varied and complicated.  Setting up a policy like this 
for the Standard Edition would allow J2EE and J2ME to follow suit 
with their Serialized Form pages.

This task breaks down to two parts:
1) Add "@serial include" and "@serial exclude" tags to doc comments
   as appropriate.  This was performed in bug report 4288648.
2) Modify the standard doclet to include/exclude the classes.
   This is the task for this bug report.
Work Around
N/A
Evaluation
Fixed for Merlin (1.4.0).   The specific fix is that javadoc now 
looks at "@serial include" and "@serial exclude" tags and 
includes/excludes classes from the serialized-form.html page.

This, however, needs to be done by passing the -private flag
into Javadoc.  Another bug (4180839) exists to fold this procedure
into the normal Javadoc run, so that the explicit -private flag 
would not be necessary.

See Comments for detail on who/when/how/ the putback was done.
 xxxxx@xxxxx  2001-02-21
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang