JDK-4290079 : stddoclet: Automate Serialized Form page for @serial include and exclude tags
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.2.0
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • OS: solaris_2.6
  • CPU: sparc
  • Submitted: 1999-11-10
  • Updated: 2014-05-05
  • Resolved: 2001-02-21
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availabitlity Release.

To download the current JDK release, click here.
1.4.0 betaFixed
Related Reports
Relates :  
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.

CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: merlin-beta FIXED IN: merlin-beta INTEGRATED IN: merlin-beta

PUBLIC COMMENTS This bug has been fixed.

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. doug.kramer@Eng 2001-02-21