Doc-O-Matic - Documentation Web Help

You are here: Creating Documentation > Topics > Creating Symbol Topics

Doc-O-Matic 6

Creating Symbol Topics

Collapse All

See Also

Creating Topics, Using QuickDoc

There are three ways to describe code in the Editor. You can:

Edit existing comments.
Create documentation for undocumented symbols.
Add comments in another location.
You can store your comment in the declaration location, the implementation location or in a DTX file. DTX files are a special kind of ASCII files, which Doc-O-Matic uses to save off-source comments to.

To document an undocumented symbol

In the Content Manager, select the symbol you want to document.
Click the QuickDoc arrow, and then select Create Documentation .
Click Cancel Edit to delete your documentation again.

To save your symbol topic

Click Save .
In the Select Topic Location dialog box, select where you want to store your topic (the declaration, the implementation location (only if it is a function or method for which Doc-O-Matic knows the implementation location) or a DTX file).

To create a DTX file

Select Select Other.
In the Select DTX file dialog box, browse through your directories to the destination where you want to store your DTX file.
Enter a filename.

To add comments in another location

Select the corresponding symbol.
In the Editor right-click, and then select New Topic Location.
Save your comments either in a DTX file or in another source location (implementation or declaration).

To edit existing comments

In the Content Manager, select the documented symbol the comment of which you want to edit.
Click Save .
Doc-O-Matic stores comments in the file and the location where it has extracted the comments from.

Notes

Click Update All , parse your files, and then edit them. Doc-O-Matic can not write to a file that has been changed (for example using your source editor) and has not been parsed afterwards.

Applies to: Doc-O-Matic Professional and Doc-O-Matic SRC