Docs/robodoc.rc

   1 #
   2 # $Id: robodoc.rc,v 1.3 2006/08/21 19:15:58 gumpu Exp $
   3 #
   4 # Example robodoc.rc file.
   5 #
   6 options:
   7     --doc MultiDocOPHHtml
   8     --one_file_per_header
   9     --src Source
  10     --html
  11     --multidoc
  12     --documenttitle "ROBODoc API"
  13     --index
  14     --cmode
  15     --tabsize 8
  16     --nopre
  17     --sections
  18 source items:
  19     SYNOPSIS
  20 items:
  21     SOURCE
  22     NAME
  23     COPYRIGHT
  24     SYNOPSIS
  25     USAGE
  26     FUNCTION
  27     DESCRIPTION
  28     PURPOSE
  29     AUTHOR
  30     CREATION DATE
  31     MODIFICATION HISTORY
  32     HISTORY
  33     INPUTS
  34     INPUT
  35     ARGUMENTS
  36     OPTIONS
  37     PARAMETERS
  38     SWITCHES
  39     OUTPUT
  40     SIDE EFFECTS
  41     RESULTS
  42     RESULT
  43     RETURN VALUE
  44     EXAMPLE
  45     NOTE
  46     NOTES
  47     DIAGNOSTICS
  48     WARNINGS
  49     ERRORS
  50     BUGS
  51     TODO
  52     IDEAS
  53     PORTABILITY
  54     SEE ALSO
  55     METHODS
  56     NEW METHODS
  57     ATTRIBUTES
  58     NEW ATTRIBUTES
  59     TAGS
  60     COMMANDS
  61     DERIVED FROM
  62     DERIVED BY
  63     USES
  64     CHILDREN
  65     USED BY
  66     PARENTS
  67 ignore items:
  68     HISTORY
  69 headertypes:
  70     u  Unittests robo_unittest
  71     x  "System tests"  robo_sys_tests
  72     e  "Makefile entries"  robo_mk_entries
  73 ignore files:
  74     t
  75     makefile.am
  76     README
  77     CVS
  78     Doc
  79     Doc1
  80     Doc2
  81     Doc3
  82     FileFilterSrc
  83     FileFilterSrc_2
  84     RoboHeaders
  85     Scr1
  86     Scr2
  87     SortSource
  88     *.dat
  89     *.html
  90     *.rc
  91     late*
  92     troff*
  93     sgml*
  94     *.css
  95     *.refs
  96     *.in
  97     *.txt
  98     *~
  99     *.stderr
 100     Scr1
 101     Scr2
 102     Doc1
 103     Doc2
 104     SortSource
 105     RoboHeaders
 106     FileFilterSrc
 107 remark begin markers:
 108     /*
 109     #
 110 remark end markers:
 111     */
 112     #
 113