Download Autoduck Tags - Literate Programming
Transcript
[/rh] [/t[0-9]] [/o filename] [/l filename] [/f filename] [/s filename] [/c filename] [/x id] [/d const_name=const _text] tagged either as "DOC" or "BOTH". This is the default. Generate RTF for Help, using the formatting information tagged either as "HELP" or "BOTH". Sets the tab size for example tags. Use the same setting used in your text editor. The default value is 8. Use output file <filename>. If no output file is specified, Autoduck creates an output file with the same filename as the first input file, and extension .RTF. Creates topic log <filename> using the topics extracted in the current build. The topic log is a list of topic names included in the current build. Use format file <filename>. If no format file is specified, Autoduck searches for Autoduck.FMT in the directory where AUTODUCK.EXE is stored, and then in the directories referenced by the PATH environment variable. Use supplemental format file <filename>. You can specify a supplemental format file in addition to the main format file. Entries in the supplemental format file override or add to the entries in the main format file. Using a supplemental file, you can define project- or group-specific variations to the default AUTODUCK.FMT file. Note that you can also insert your additional entries at the beginning of the AUTODUCK.FMT file. This way, the local entries will be used in place of the standard ones, and you can avoid specify the /S option each time you run Autoduck. Specifies topic log <filename> for the build. The topic log specifies a list of topics that can be linked to and is generally used to determine what type of formatting information to output for a paragraph or text tag (for example, bold if no topic is available, and hypertext link if a topic is a available). Specifies an extraction expression for the build. Only those topics with @doc flags matching the expression are extracted. If no extraction flags are specified, all topics are extracted. For more information on extraction expressions, see “Extraction and Filtering Expressions” and “Conditional Topic and Paragraph Extraction”. Defines a text constant "const_name" as "const_text". Constants can be referenced in the format file for RTF output. By defining a constant on the command line, you can override a constant defined in the format file. For more information on constants, see the discussion of the [CONSTANT] section. Makefile Entries for Autoduck The DKOALA example project included with Autoduck uses MAKEDOCS.MAK, a Microsoft Visual C++ makefile. MAKEDOCS.MAK is a generic Autoduck makefile that generates Help and Print documentation files using the set of C/C++ files in the current