Contents | Parent Topic | Previous Topic | Next Topic
Home | Catalog
SDG files are used to format information extracted from source code by sdfget.
An SDG is a table of Key-Format pairs. For example:
Key Format - "Key\t\tDescription\n" * sprintf("%-15.15s\t%s\n", $key, $data)
The first line specifies the layout of the table and is required. An item is only printed if it has a description. The Key field can be one of the following:
The Format field is a Perl expression. $key and $data are used to indicate the key and description of the current item respectively. Other available symbols are:
The SDG file used to format topics within the SDF documentation is:
Key Format Title "H1[id=\"$short\"] $short - $data\n\n" Purpose "H2: $key\n\n$data\n\n" Interface "H2: $key\n\n$data\n\n" - "!SDF_DESCRIPTION_PRE\n" Description "H2: $key\n\n$data\n\n" - "!SDF_DESCRIPTION_POST\n" Examples "H2: $key\n\n$data\n\n" Limitations "H2: Limitations and future directions\n\n$data\n\n" - "!SDF_DEFAULT_END\n"
Contents | Parent Topic | Previous Topic | Next Topic
Home | Catalog