Doc-O-Matic - Documentation Web Help

You are here: AutoDoc and Formatting > Customizing AutoDoc Parts > Changing Code Presentation

Doc-O-Matic 6

Changing Code Presentation

Collapse All

See Also

Sections

Related Settings

Code Option, Output Options

Doc-O-Matic provides several ways to include your C++, C#, Delphi, IDL, Java, JavaScript, VB.NET, MATLAB, ASPX, PHP and JSP source code in your documentation. To include source code from generic source files in the output select the Use everything in the file and Use comments and source till line check box in the Edit Generic Source dialog box. For more information, see Documenting Generic Source Files.

To customize declaration source - syntax

Doc-O-Matic presents declaration sources (regenerated by Doc-O-Matic) for each symbol. In addition, Doc-O-Matic can present your declaration source in another programming language.
To omit the syntax for your symbols in the original language, clear the Print declaration syntax in the original source language check box on the Multi Language Syntax page.
To omit the syntax for other programming languages, clear the Print declaration syntax in multiple source languages check box on the Multi Language Syntax page.
To omit syntax sections, clear the respective Syntax section check box on the Files & FormatSections page.
To replace declaration sources by your own sources, add a syntax section to the respective topic.

To customize body source code

To add body source, select the Add function's body source code or Add file's body source code check box on the Body Source Code page.
To syntax highlight and autolink body source code select the corresponding check boxes on the AutoDocCode OptionsBody Source page.
To number source code lines, expand tabs and omit comments select the corresponding check boxes on the AutoDocCode OptionsBody Source page.
To add body source on a per-topic basis, use the topic property Body Source or the implementation tag or the property tag and the attribute implementation in your source code.
Body source appears as Body Source section and in Help systems on a separate page. To remove body source code sections, clear the Body Source section check box on the Files & FormatSections page.
To remove body source code pages in Help systems, clear the Body Source link check box on the Files & FormatSectionsNavigation Links pages.
To add text to the body source section add a section of the type Source Description to the respective topic.

Notes

To format the declaration source sections you can either use the Syntax Source Code Formatting Element or create a separate section element for each syntax section.