home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / makedoc_v1.1.lha / makedoc / doc / english / makedoc.doc < prev   
Encoding:
Text File  |  1995-01-09  |  5.2 KB  |  134 lines
  1. makedoc                                                                 makedoc
  2.  
  3. $VER: makedoc.doc 1.1 (08.05.94)
  4.  
  5. NAME
  6.     makedoc
  7.  
  8. FORMAT
  9.     makedoc [FILES] file1 [file2] [...] AUTODOC docfile [TEMPFILE temporyfile]
  10.             [BEGIN string] [END string] [SKIPSTRING string] [TABS numspcs]
  11.             [LINELENGTH numchars] [CONVERTCOMMENTS] [NOWORDWRAP] [NOFORMFEED]
  12.             [TOC] [LANGUAGE lang] [AMIGAGUIDE] [NOICON] [VERBOSE]
  13.             [APPEND file] [VERSION version-number] [REVISION revision-number]
  14.             [REVISIONFILE file]
  15.  
  16. TEMPLATE
  17.     FILES/M/A,AUTODOC/K/A,TEMPFILE/K,BEGIN/K,END/K,SKIPSTRING/K,TABS/N,
  18.     LINELENGTH/N,CONVERTCOMMENTS/S,NOWORDWRAP/S,NOFORMFEED/S,TOC/S,
  19.     LANGUAGE/K,AMIGAGUIDE/S,NOICON/S,VERBOSE/S,APPEND/K,VERSION/N,
  20.     REVISION/N/K,REVISIONFILE/K
  21.  
  22. FUNCTION
  23.     extracts documentfragments from source code files and saves this in a
  24.     documentation file in sorted order (Format : AutoDoc).
  25.     Makedoc supports extraction of different languages for a documentation.
  26.     To do that , you must specifiy in the BEGIN string the "LL" substring,
  27.     to match at this point the different langauges with the following
  28.     abbreviation :
  29.  
  30.       "DK" -    dansk
  31.       "D?" -    deutsch
  32.       "E?" -    español
  33.       "F?" -    français
  34.       "GB" -    english
  35.       "I?" -    italiano
  36.       "NL" -    nederlands
  37.       "N?" -    norsk
  38.       "P?" -    português
  39.       "S?" -    svenska
  40.  
  41.     Makedoc creates also icons for a documentation, if the NOICON option
  42.     isn't specified. Makedoc looks first for the Env:sys/def_doc.info
  43.     icon and if this doesn't exist it uses the WBPROJECT icon !
  44.     If you specify a REVISIONFILE makedoc searches in the found documentation-
  45.     fragments for the version pattern : "$VER: " and if it founds it, it fills
  46.     teh appropriate values in (VERSION,REVISION,NAME and DATE).
  47.  
  48. INPUT
  49.     FILES - one or more sourcefiles
  50.     AUTODOC - AutoDoc file to create. If no language is specified , then
  51.         makedoc searches here for a language specific directory-name. For
  52.         example a full path like the following use the english language to
  53.         extract the documentation : doc/english/test.doc
  54.     TEMPFILE - tempory file to use
  55.     BEGIN - String, which indicates the beginning of a documentation fragment
  56.         (Default : "/******")
  57.     END - String, which  indicates the end of documentation fragment
  58.         (Default : "***")
  59.     SKIPSTRING - String, which is skipped at the beginning of each line in the
  60.         documentation fragment (Default : "*")
  61.     TABS - number of blanks to replace a tabulator
  62.     LINELENGTH - maximal length of a line (Default : 78)
  63.     CONVERTCOMMENT - converts backslashes to slash, if before or after there
  64.         is an asterik
  65.     NOWORDWRAP - turns wordwrap off
  66.     NOFORMFEED - turns formfeed off , after each documentation fragment
  67.     TOC - creates at the beginning of the Autodoc a table of contents
  68.     LANGUAGE - specifiy the langauge for the documentation to be extracted.
  69.         See list of languages above.
  70.     AMIGAGUIDE - places a @node before and a @endnode after the
  71.         documentation fragment. Thus you have AmigaGuide Nodes !
  72.     NOICON - creates no icons for the AutoDoc file 
  73.     VERBOSE - shows parse informations
  74.     APPEND - file to append at the end of the documentation
  75.     VERSION - version number of the documentation/program (Default : 0)
  76.     REVISION - revision number of the documentation/program
  77.     REVISIONFILE - file, which contains the revision of the documentation/
  78.         program (see bumprev).This argument overrides the REVISION argument
  79.         and additionly it uses the date of the file for the $VER: date.
  80.  
  81. EXAMPLE
  82.     makedoc test.c AUTODOC test.doc BEGIN "/**LL******" END "******" \
  83.             SKIPSTRING "**" TOC VERBOSE NOFORMFEED LANGUAGE english
  84.  
  85.     or
  86.  
  87.     makedoc test.c AUTODOC doc/english/test.doc BEGIN "/**LL******"  \
  88.             END "******" SKIPSTRING "**" TOC VERBOSE
  89.  
  90.     extracts only following fragments :
  91.  
  92.     /*GB*** test.lib/test.c **************************************************
  93.     *
  94.     * here the documentation
  95.     *
  96.     ***** END of documentation **********************************************/
  97.  
  98.     The following command , extracts only fragments for menus :
  99.  
  100.     makedoc test.c AUTODOC test.doc BEGIN "/**LL**MENU**" END "******" \
  101.             SKIPSTRING "**" TOC VERBOSE NOFORMFEED LANGUAGE english
  102.  
  103.     extracts only fragments like the following :
  104.  
  105.     /*GB*MENU* Menu/Project/Open *********************************************
  106.     *
  107.     * here the menu-documentation
  108.     *
  109.     ***** END of Menu-documentation *****************************************/
  110.  
  111. NOTE
  112.     makedoc uses ReadArgs to parse the command line, thus if you specify a "*"
  113.     in a string , you must do this twice for each character you want. ReadArgs
  114.     uses this character to output special characters like a newline.
  115.  
  116. SYSTEM REQUIREMENT
  117.     Any Amiga with at least OS2.04 (V37) or higher.Look out for OS3.x, it's
  118.     a great improvement to OS2.04 (see Datatypes ...) !!!
  119.  
  120. SEE ALSO
  121.     autodoc
  122.  
  123. COPYRIGHT
  124.     (C) Copyright 1993,1994 by Stefan Ruppert
  125.     Makedoc is freely distributable, if any file in Contents-List is not
  126.     modified and copied.
  127.  
  128. IDEAS,BUGS ?,GIFTS,PROGRAMS AND AMIGAS TO
  129.     Stefan Ruppert
  130.     Windthortstraße 5
  131.     65439 Flörsheim am Main
  132.     Germany
  133.  
  134.