You are here: AutoDoc and Formatting > Customizing AutoDoc Parts > Changing Code Presentation
Close
Doc-O-Matic 10
Changing Code Presentation

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.

  1. 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. Syntax sections are by default displayed as tabbed sections using the tab set name Syntax as section heading.
  2. 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.
  3. 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.
  4. To omit syntax sections, clear the respective Syntax section check box on the Files & Format > Sections page.
  5. To omit tab sets for syntax sections, clear the Tabbed section check box on the Files & Format > Sections page for each syntax sections (e.g. Visual Basic, Pascal, C++).
  6. To omit the section heading Syntax for syntax sections, delete the tab set name Syntax in the Tab Set field on the the Files & Format > Sections page for each syntax sections (e.g. Visual Basic, Pascal, C++).
  7. To replace declaration sources by your own sources, add a syntax section to the respective topic.
  1. 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.
  2. To syntax highlight and autolink body source code select the corresponding check boxes on the AutoDoc > Code Options > Body Source page.
  3. To number source code lines, expand tabs and omit comments select the corresponding check boxes on the AutoDoc > Code Options > Body Source page.
  4. 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.
  5. 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 & Format > Sections page.
  6. To remove body source code pages in Help systems, clear the Body Source link check box on the Files & Format > Sections > Navigation Links pages.
  7. To add text to the body source section add a section of the type Source Description to the respective topic.

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 (e.g. Visual Basic, Pascal, C++).

Code Option, Output Options, Sections

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