# Example robodoc.rc
#
items:
    NAME
# SAR 31 Dec 2011: Added DATE back to ITEMS block
    DATE
# MDE Sat May 19 13:06:45 2012 -- replaced FUNCTION with DESCRIPTION
    DESCRIPTION
# SAR 10.12.11: Added ARGUMENTS, OPTIONAL ARGUMENTS, and RETURNS to the items
# MDE Sat Mar 23 10:53:59 2019 -- added AUTHOR
# block 
    ARGUMENTS
    AUTHOR
    OPTIONAL ARGUMENTS
    RETURN VALUE
    EXAMPLE             
    SYNOPSIS
    INPUTS
    OUTPUTS
    SIDE EFFECTS
    HISTORY
    BUGS
ignore items:
    HISTORY
    BUGS
# item order:
#       FUNCTION
#       INPUTS
#       OUTPUTS
#       SYNOPSIS
source items:
     EXAMPLE
     SYNOPSIS
# preformatted items:
#     INPUTS
#     OUTPUTS
# format items:
#     FUNCTION
#     SIDE EFFECTS
options:
    --src ../../src/
# 28.11.11 SEAN: Changed the output dir to ../doc/ to suit new dir structure. 
# 7.12.11 ME: changed to ../doc/robodoc
# MDE Wed Feb 29 14:23:27 2012 -- .rc files are now in the doc dir
    --doc ./
    --html
#    --dbxml # docbook
#    --rtf
#    --latex
# 02.12.11 SEAN: commented --sections again to take hierarchy out of TOC
#      --sections
    --multidoc
#    --singledoc
    --index
    --tabsize 8
#    --documenttitle "<a href='http://www.michael-edwards.org/sc>'>slippery
#chicken</a>" 
     --documenttitle ""
    --masterindex "Index,roboindex"
#    --css robodoc-multi-blue.css
#    --css anthropod.css
# 09.12.11 SEAN: changed reference to one single stylesheet located in doc/
# MDE Tue Feb 14 19:32:11 2012 -- changed to sc-stylesheet.css
    --css ../sc-stylesheet.css
#     --css randombanana.css
#    --nopre
headertypes:
      S  "Slots"             robo_slots 0
      P  "Global Parameters" robo_parameters 0
#     J  "Projects"          robo_projects    2
#     F  "Files"             robo_files       1
#     e  "Makefile Entries"  robo_mk_entries
#     x  "System Tests"      robo_syst_tests
#     q  Queries             robo_queries
ignore files:
    README
    CVS
    .svn*
    *.bak
    *~
    "a test_*"
    cm-2.6.0
    *.dylib
    *.dSYM
    *.c
    *.o
    *.so
    *.txt
    TAGS
accept files:
    *.lsp
# 06.12.11 SEAN: changed the header-, remark-, and end-markers to allow for
# better looking html layout of the EXAMPLE block.
header markers:
    ;;; ****
    ;; ****
remark markers:
    ;;;
    ;;
    #|
    |#  
end markers:
    ;;; **** 
    ;; ****
# header separate characters:
#     ,
# header ignore characters:
#     [
remark begin markers:
    #|
remark end markers:
    |#
#source line comments:
#    ;;;
#    ;;
#    ;
keywords:
    if
    loop
    defun
    defmethod

