I m using an external java library for which I only have the javadocs and do not have the source code. I d like to generate a UML diagram from the existing javadocs so that I can visualize the class hierarchy using something like Graphviz. Is that possible? Note that what I m looking for is a graphical version of overview-tree.html.
Please let me know if you have any ideas and/or suggestions.
Thanks,
Shirley
I don t believe that there is such a tool. Most of the reverse engineer tools depend on the actual code. The javadoc information isn t guaranteed to match the code as a 1:1 for the structure, thus making it unreliable.
I m not familiar with any off-the-shelf solution for this purpose. Most commonly folks have the source code that generated the JavaDoc.
That being said, the overview-tree.html traditionally has a fairly straightforward HTML format. It should not be difficult to write a script that would read the file as text or as a DOM, reconstruct the hierarchy of UL and LI tags, and use that to build an input file for graphviz. I ve done similar stuff in the past with other forms of data.
It s just a matter of time and proficiency with the scripting language or appropriate tools.
The one problem of this approach is that you would only get the hierarchy of classes. You would have to make it somewhat smarter if you wanted to get the "implements XYZ" and create multiple hierarchies. Even if you could get that data, you would have to manipulate GraphViz s levels to get it to provide an appropriate layout once you have this multiple inheritance structure.
Of course, adding the details of the members would turn this into a whole new problem since you will have to access other HTML files.
I m using an external java library for which I only have the javadocs and do not have the source code. I d like to generate a UML diagram from the existing javadocs so that I can visualize the class ...
Java example method: //Stores the user input into an integer variable called choice int choice = keyboard.nextInt(); Do I need to write javadoc for a simple method like this or should I only ...
I have a number of JUnit test cases that are currently not documented with Javadoc comments. The rest of my code is documented, but I m wondering if it s even worth the effort to document these tests....
Trying to find a way to automate the API from javascript comments.
Unfortunately, there is no CDATA in HTML. This is a pity, because it would be perfect for adding javadoc comments that include XML, so you don t have to escape the < and >, for example: /**<