Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

#118 Javadoc Integration

closed
9
2003-06-27
2002-11-14
Charles Reis
No

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?)

Discussion

  • Charles Reis
    Charles Reis
    2003-02-24

    • priority: 5 --> 9
     
  • Charles Reis
    Charles Reis
    2003-02-24

    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
    hperkins
    2003-03-11

    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
    Charles Reis
    2003-03-12

    • assigned_to: nobody --> centgraf
     
  • Charles Reis
    Charles Reis
    2003-06-27

    • status: open --> closed
     
  • Charles Reis
    Charles Reis
    2003-06-27

    Logged In: YES
    user_id=429731

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