From 8a0a8a49472dc879188215838e83ae00fc78fb3f Mon Sep 17 00:00:00 2001 From: Robin Haberkorn Date: Tue, 26 Feb 2013 16:35:08 +0100 Subject: 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: 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 --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to '.gitignore') diff --git a/.gitignore b/.gitignore index 3e71041..ccbc6d6 100644 --- a/.gitignore +++ b/.gitignore @@ -22,7 +22,8 @@ stamp-* /src/sciteco-minimal # Generated code -/doc/sciteco.1 +/doc/sciteco.[17] +/doc/sciteco.7.in /doc/Doxyfile /doc/doxygen -- cgit v1.2.3