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 --- doc/sciteco.7.template | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 doc/sciteco.7.template (limited to 'doc/sciteco.7.template') diff --git a/doc/sciteco.7.template b/doc/sciteco.7.template new file mode 100644 index 0000000..aaffb7b --- /dev/null +++ b/doc/sciteco.7.template @@ -0,0 +1,12 @@ +.ds ST \\fB@PACKAGE_NAME@\\fP +. +. +.TH "@PACKAGE@" 7 \ + "@DATE@" \ + "@PACKAGE_NAME@ Version @PACKAGE_VERSION@" +.. +. +.SH COMMAND REFERENCE +\#$COMMANDS +.. +\# EOF \ No newline at end of file -- cgit v1.2.3