aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/generate-docs.tes
AgeCommit message (Collapse)AuthorFilesLines
2013-03-17use new ^E\ string building character for arrays and to simplify number ↵Robin Haberkorn1-1/+1
insertions
2013-03-16generate-docs: marker looks like a Troff request nowRobin Haberkorn1-1/+1
it is customary for Troff preprocessors to interpret special preprocessor requests instead of special comments
2013-03-16documented generate-docs.tes Troff preprocessorRobin Haberkorn1-0/+27
2013-03-16first draft of TECO command documentation generatorRobin Haberkorn1-0/+125
* 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