#118 Javadoc Integration

[Charles Reis]

Story: User wishes to view a high level API of a class
he is writing. He selects "View Javadoc" from the
Tools menu and the Javadoc for the current class is
generated and displayed as another open document. As a
non-Java document, the Compile, Test, etc. actions are
disabled, but the user is able to save the file if he
wishes.

JEditorPane provides the functionality needed to
display web pages, so the only catch is figuring out
how to generate the Javadoc programmatically. (Is
there an API?)

[Charles Reis]

Logged In: YES
user_id=429731

This has been repeatedly requested from some of our
customers, and has good educational value for distinguishing
between interface and implementation. (Not to mention the
fact that it encourages good documentation.) We hope to
implement this as part of a 312 project.

Things to note: it would be nice to automatically save the
javadoc in some directory (perhaps a "javadoc" subdirectory
of the class file), and there should probably be a way to
run javadoc on all open files. (Later, on all files in a
project or directory.) We might want to take a look at
Ant's code to see if there's a programmatic interface to
Javadoc we can use.

[hperkins]

Logged In: YES
user_id=728235

Eclipse seems to have a reasonably effective javadoc
interface and since it's open source, there might be
some clues there about how to interface with javadoc.

BlueJ has a similar feature, which saves the
documents in a doc subdirectory of the current project
with an appropriate top-level index.html file. Very
convenient and very useful in teaching.

[Charles Reis]

Logged In: YES
user_id=429731

Just updating this to reflect that it's being addressed as
one of our tasks in Comp 312. The related subtasks are
available here:

https://sourceforge.net/pm/task.php?group_project_id=27301&group_id=44253&func=browse

[Charles Reis]

Logged In: YES
user_id=429731

This feature is enabled and usable in drjava-20030627-1927.