|
Using |
To add javadoc comments to your code:
Filesystems tab.Tools -> Auto Comment... from the popup menu.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
Project -> Settings.Documentation
on the left.Javadoc Executor Type to Internal
Javadoc.Ask for Destination Directory to true,
so that you can specify where to put the Javadoc each time it's generated.Javadoc Executors on the left to show its subnodes.Internal Javadoc, and change Members
on the right to private.Doclets and select
Standard Doclet.Author and Version to true. This tells Forté
to include your @author and @version tags in the
generated documentation.To generate javadoc documentation:
Filesystems tab.Tools -> Generate Javadoc from the popup menu.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.