diff options
| author | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2013-02-26 16:35:08 +0100 | 
|---|---|---|
| committer | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2013-03-16 18:07:30 +0100 | 
| commit | 8a0a8a49472dc879188215838e83ae00fc78fb3f (patch) | |
| tree | 3f9f8700fb62ccd7f7c5d083c18098ecd670ae2d /src/expressions.h | |
| parent | 1c4127666adfded4f7caf58fc30040cb235107d1 (diff) | |
first draft of TECO command documentation generator
 * the language reference is a manually written man-page template
 * containing special references for generated documentation (\#$...)
 * SciTECO script generate-docs.tes extracts TECO comments (/*$ ... */)
   from all source files and transforms them to Troff requests that are
   inserted into the document template.
 * TECO doc comments are a rather sophisticated markup:
   * first part until empty line is called header: simplified command syntax descriptions
   * the rest is called body: <identifier> is automatically underlined,
     empty lines generate new paragraphs, lines beginning with "-" or numbers
     denote an indented unordered or numbered list item.
   * regular Troff requests/macros can be used for more sophisticated markup
   * since Autoconf substitutions are performed on the generated man-page,
     @VARIABLEs@ may be used in doc comments as well
Diffstat (limited to 'src/expressions.h')
0 files changed, 0 insertions, 0 deletions
