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: 4784198
Votes 22
Synopsis Java API Documentation needs to include class diagrams
Category doclet:tbd
Reported Against 1.4.1
Release Fixed
State 5-Cause Known, request for enhancement
Priority: 4-Low
Related Bugs
Submit Date 25-NOV-2002
Description




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) 
======================================================================
Work Around
N/A
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.

  xxxxx@xxxxx   2002-12-03
  xxxxx@xxxxx   2004-12-16 23:30:10 GMT
Comments
  
  Include a link with my name & email   

Submitted On 04-FEB-2003
telemus
A package to automatically generate class diagrams like
those at falkhausen.de should be included in a future
version of Java.


Submitted On 04-MAY-2003
petit
A package to automatically generate class diagrams like
those at falkhausen.de should be included in a future
version of Java.
He's right You know - and his diagrams are a beauty :-)
Bertil G


Submitted On 28-MAY-2003
tluteran4
ditto telemus' comments of 4 Feb 2003
Graphic depiction of the classes is essential for me to get a 
fast, concise overview of the entire framework of the 
language.  

Providing a tool has a dual benefit: 1. Sun can reuse at any 
time it generates a new release of Java, or 2. Sun or anyone 
can use the tool to provide class diagrams of ANY package!!

Come on, time to communicate using UML!!  After all, we use 
it to communicate our designs, why not use it for the design 
of the infrastructure that we are building on?
--


Submitted On 09-JUL-2003
irina056
Diagrams are very Usefull to scan/learn things quickly , 
especially when you first time going to use some package.
Falkhausen does GOOD Job!!! I like it.
It may be usefull to enter some signs to identify on the 
diagrams the deltas/changes of the version. To the full 
explanation of the changes link to other HTML.


Submitted On 29-MAR-2004
hoppis
A package to automatically generate class diagrams 
like those at falkhausen.de(beauty ones)should be 
included in a future version of Java. 


Submitted On 23-JUL-2004
3testing
It should not difficult to develop a UML class diagram during javadoc generation such as the one provided by yWorks' yDoc (although this is only confined to the current class). This integrates nicely with javadoc and does not need too much extra work. It uses SVG.


Submitted On 23-JUL-2004
3testing
Forgot to put the link: http://www.yworks.com/en/products_ydoc.htm


Submitted On 08-SEP-2004
bhaiabrar
Work done by Falkhausen.de is fine but is limited to J2SE only. How about extending it to J2EE or fund them  to do so.


Submitted On 05-OCT-2004
satish101
A package to automatically generate class diagrams like
those at falkhausen.de should be included in a future
version of Java


Submitted On 20-OCT-2004
eduardo_frigerio
A package to automatically generate class diagrams like


Submitted On 15-DEC-2004
jgk000
I have searched  many hours for  this solution!
Jarek


Submitted On 23-MAR-2005
JBarker_org
I too would like to see something similar to that on falkhausen.de


Submitted On 12-MAY-2005
ovidiup51
Just extend javadoc comments (optional / javadoc recommendation) to include diagram-related properties (like: this method should appear in diagram with no param., this field should also show the default value etc.). Generation afterwards should be quite straightforward if this data is in place (UML community tools, plugged in javadoc, can be used).
As proof of concept, a free generation tool verified against falkhausen test cases can be released before any “official” effort.
The return on investment would include better Java language penetration and also better A&D on the core classes (including J2EE).


Submitted On 26-JAN-2006
wherisat1
This would REALLY REALLY be slick. I mean REALLY.


Submitted On 07-MAY-2007
Any hope of ever seeing this?  It *would* save me hours of studying as it's easier to understand layered information if it's drawn out; what's the programmer's number 1 rule for starting any project... draw a picture.  I have to run and memorize the first 1300 pages of my intro to Java book  for my 8am final which starts in 2 hours...Arg!


Submitted On 11-JUL-2007
Just extend javadoc comments to automatically generate class diagrams 


Submitted On 15-MAR-2008
UpendraJariya
Please add class diagrams as an on-demand feature to Java API docs.
Class diagrams are really very useful when some one tries to study a package thoroughly. And they become far more importent is somebody wants to implement some API e.g. JAXP for a new DOM implementation - my requirement.


Submitted On 22-JAN-2009
ankit.khandelwal
It is high time sun realizes the importance of visual documentation. UML has come of age and doesn't need introduction. Should take it a step at a time adding class diagrams first, then may be follow it with sequence diagrams



PLEASE NOTE: JDK6 is formerly known as Project Mustang