Using Javadoc

Javadoc is a very popular documentation standard. If you document your source code in accordance with the Javadoc standard, it is very easy to adjust Doc-O-Matic. For more information about placing comments, see Adjusting Doc-O-Matic.

Javadoc tags

To structure comments Javadoc supports specific tags (for example @param). Doc-O-Matic supports most standard Javadoc tags. Doc-O-Matic also supports several non-standard Javadoc tags that are used by other documentation tools such as Doxygen. If you use \ as starter for Javadoc you need to turn on \ support. Most tags are interpreted as Doc-O-Matic sections some are interpreted as character formatting. Handling Javadoc describes how Doc-O-Matic maps standard and non-standard Javadoc tags.

To insert Javadoc tags

Doc-O-Matic can insert Javadoc tags (either @ or \ as starters) in your source code, when you write your comments in the Editor.
The setting Documentation Standard determines which standard is used to insert comments. Using the Javadoc standard Doc-O-Matic transforms your comments into text and standard Javadoc tags.
If you use sections be sure to enter the Javadoc tag you want to be inserted as starter for this section as first string in Javadoc in the Edit Section dialog box of this section.
For more information about how Doc-O-Matic enters comments in your source, see Inserting Comments. Javadoc tags can only be inserted into natively supported language files and not in DTX files.

Applies to: Doc-O-Matic Professional