You are here: AutoDoc and Formatting > Formatting the Output > Formatting Topic Pages > Sections > Parameters, Return Values and Members Section
Parameters, Return Values and Members Section
Close
Doc-O-Matic 10
Parameters, Return Values and Members Section

Parameters, return values and member descriptions are very important parts of each symbol description. Descriptions of members of structures, records and enums are automatically created by Doc-O-Matic. They are included in the Member Section.

  1. There are two ways how you can present these types of sections in the outputs. You can present them:
    • In a two-column table with table header.
    • As paragraphs. Paragraphs look like this in the output:
parameter code or name parameter description
  1. Style for these sections can be chosen on the Files & Format > Sections > Format page. For each style there are separate Formatting Elements.
    • Paragraph style: Parameter Paragraph Code, Parameter Paragraph Description.
    • Table: Parameter Table, Parameter Table Left Column (and Header) Parameter Table Description (and Header).
  2. On the AutoDoc > Section Options page, you can:
    • Show member or parameter names in the first line or the left column of the table.
    • Show the full parameter or member declaration. (default setting).
  3. You can set table widths on the AutoDoc > Section Options > Table Layout page.

Section Options, Table Layout, Sections Format

Parameter Paragraph Code, Parameter Paragraph Description, Parameter Table

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