[DrJava] [ drjava-Bugs-767424 ] JavaDoc usage

[SourceForge.net <no...@so...>]

Bugs item #767424, was opened at 2003-07-07 16:58
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=438935&aid=767424&group_id=44253

Category: Javadoc integration
Group: None
Status: Open
Resolution: None
Priority: 5
Submitted By: Hal Perkins (hperkins)
Assigned to: Nobody/Anonymous (nobody)
Summary: JavaDoc usage

Initial Comment:
After working with the JavaDoc interface for a bit, I 
realized that there are two distinct reasons for 
generating JavaDoc, and the current DrJava interface 
isn't quite right for both of them.  There are two stories:

1) User is working on a file and wants to see/proofread 
the JavaDoc generated from that one file.  The 
generated JavaDoc for this use would benefit from not 
having all the links to inherited information -- the user is 
essentially toggling between the JavaDoc and source for 
the class.  Itwould be best to have the JavaDoc appear 
in a simple window with no frames.  (BTW, this is a 
powerful teaching tool since it makes a strong 
distinction between the implementor's and client's view 
of a class.)

2) User wants to generate JavaDoc for the entire 
project, either for his/her personal use or to make it 
available to others.  This is best displayed in a standard 
JavaDoc framed viewer, with lists of classes to the left, 
an index at the top, etc.

I'm not sure if this really qualifies as a bug or as a 
feature request, so my apologies if it's posted in the 
wrong place.  However, it'd be great to think this 
through and refine the interface.

Thanks

Hal

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=438935&aid=767424&group_id=44253