United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: 4784198 Java API Documentation needs to include class diagrams
4784198 : Java API Documentation needs to include class diagrams

Details
Type:
Enhancement
Submit Date:
2002-11-25
Status:
Open
Updated Date:
2008-03-31
Project Name:
JDK
Resolved Date:
Component:
docs
OS:
windows_2000
Sub-Component:
doclet
CPU:
x86
Priority:
P4
Resolution:
Unresolved
Affected Versions:
1.4.1
Targeted Versions:

Related Reports

Sub Tasks

Description

Name: gm110360			Date: 11/25/2002


FULL PRODUCT VERSION :
version 1.4.1

A DESCRIPTION OF THE PROBLEM :
The Java standard libraries are ever expanding. The Javadoc
generated API documentation is helpful but becomes difficult
to survey. A new kind of information compression is necessary.
Class diagrams could be up to this job.

  To be really useful these diagrams should be created by humans
and included in the HTML-documentation. The various elements
in the diagram should link to the normal API specifications.


REPRODUCIBILITY :
This bug can be reproduced always.

CUSTOMER WORKAROUND :
Class diagrams for JDK 1.4 that illustrate the concept
are found at www.falkhausen.de/en/index.html
(Review ID: 178316) 
======================================================================

Comments
EVALUATION

The work at falkhausen.de would be an enormous amount 
of work for us to reproduce.  Since that work is already done, it seems
better to simply point to that work, perhaps from our docs page and javadoc
FAQ page.

###@###.### 2002-12-03
###@###.### 2004-12-16 23:30:10 GMT
2002-12-03


Hardware and Software, Engineered to Work Together