You are here: More Information > Special Tasks
Special Tasks
Technical Reference
> Adjusting Doc-O-Matic
File and Parsing Options
Adjusting Doc-O-Matic
Close
Doc-O-Matic 10
Adjusting Doc-O-Matic

If your source code is already documented, you can adjust Doc-O-Matic to your way of documenting source code in the Settings. The following questions help determine whether the default project supports your comment style or not. Answer the following questions and complete the following steps. If your answer is "no" the default settings for extracting comments should support your comment style. If your answer is "yes" , you must change some Settings to adjust Doc-O-Matic to your comment style.

Your comment style
Adjusting Doc-O-Matic
Do you use Javadoc to document your source?
On the [General Settings] > Sections > Javadoc page you can turn on Javadoc support. For details, see Using Javadoc.
Do you use \ as starter for Javadoc?
On the [General Settings] > Sections > Javadoc page you can turn on support for \ Javadoc tags.
Do you use XMLDoc tags to document your source?
XMLDoc tags support is turned on by default. The default setting can be changed on the [General Settings] > Sections > XML page. For details, see Using XML.
Do your comments follow symbol declarations in one of the next lines?
On the [General Settings] > Documentation > Comment Finding page select the Associate comment with previous symbol check box. You can find out more about comment locations in Comment Finding.
Do you use tokens to distinguish documentation comments from other comments?
On the [General Settings] > Documentation > Comment Finding > Token page enter your tokens. The default tokens are @@. The option Force token usage for code symbols makes Doc-O-Matic extract only comments beginning with tokens. For more information about tokens, see Token.
Do you use table header lines, headings, bulleted lists, walls, parameter delimiters or tails?
Doc-O-Matic supports the most common characters for these parts of your comments. To make sure Doc-O-Matic processes your comments correctly enter the characters you use in Characters on the [General Settings] > Documentation > Comment Style. You can find out more about formatting comments in Formatting Comments.
Do you divide your comment block into logical areas? (For example See Also links, remarks, parameter descriptions)
Find information about how to adjust Doc-O-Matic to your way of using sections in Section Adjustment.
Do you use delimiters to separate section starters from section text?
Find information about how to adjust Doc-O-Matic to your way of using delimiters in Section Adjustment.
For parameter description are you using the complete parameter declaration instead of just the name?
The default configuration for parameter description is "simple". Select another option on the [General Settings] > Documentation > Comment Style > Parameters page.

Doc-O-Matic can also be adjusted to your way of documenting. 

You can:

  • Use skip tokens. The default skip token is !ignore me!.
  • Use initializer for documentation comments.
  • Ignore all all comments.
  • Set off your comments more than five positions from the symbol. The default maximum distance is five.
  • Expanded tabs to more than four spaces. Doc-O-Matic expands tabs to four spaces by default.
  • Ignore comments in parameter lists located after the parameter declaration. Doc-O-Matic recognizes parameter list inline comments by default.

Javadoc, XML, Comment Finding, Token, Comment Style, Parameters

Copyright © 2000-2020 toolsfactory software inc. All rights reserved.