Using javadoc from within Forté
by David Matuszek

To add javadoc comments to your code:

  1. In the Explorer window, click on the Filesystems tab.
  2. Right-click on the class you wish to add comments to.
  3. Choose Tools -> Auto Comment... from the popup menu.
  4. Pick a method or constructor from the right pane, and enter text for it.

Notice also the row of icons along the top. You can choose to document only public constructors and methods, or also protected, package, and private ones.

This is just an aid for inserting comments in your code; you can, of course, just type them directly into your program. Generating the actual javadoc files from your code is a separate step.

To change javadoc settings:

By default, Forté only generates documentation for public code (classes, constructors, methods, variables). To generate more complete documentation, do the following

  1. From the top-most menu, choose Project -> Settings.
  2. In the Project Settings window, click on Documentation on the left.
  3. On the right, change Javadoc Executor Type to Internal Javadoc.
  4. Change Ask for Destination Directory to true, so that you can specify where to put the Javadoc each time it's generated.
  5. Double-click on Javadoc Executors on the left to show its subnodes.
  6. Click on Internal Javadoc, and change Members on the right to private.
  7. In the Project Settings window, expand Doclets and select Standard Doclet.
  8. Set Author and Version to true. This tells Forté to include your @author and @version tags in the generated documentation.

To generate javadoc documentation:

  1. In the Explorer window, click on the Filesystems tab.
  2. Right-click on the filesystem (or the individual class) that you wish to generate javadoc for.
  3. Choose Tools -> Generate Javadoc from the popup menu.
  4. Wait a few seconds--javadoc is not extremely fast. A dialog box will pop up, asking whether you want to see the newly-generated documentation. Yes is a good answer, but it's up to you.