robodoc.rc

#****iB* Build/robodoc.rc
# PURPOSE
#   Defines robodoc's configuration for this project.
#   Robodoc is a documentation compiler. It does the following in this project:
#   - parse source files for specially formatted comments
#   - run any external tools as directed in the comments
#   - compile HTML documentation from the output of the previous steps
# SEE ALSO
#   - [ROBOdoc Manual](https://rfsber.home.xs4all.nl/Robo/pages/robodoc-49942-user-manual.html#header_types)
#******
items:
    COPYRIGHT
    LICENSE
    ATTRIBUTION
    NAME
    USAGE
    PURPOSE
    DESCRIPTION
    TAGS
    ENVIRONMENT VARIABLES
    INPUTS
    RETURN VALUES
    ERRORS
    SIDE EFFECTS
    PRECONDITIONS
    POSTCONDITIONS
    INVARIANTS
    SECURITY
    ATTACK SURFACE
    THREATS
    PERFORMANCE
    NOTES
    TESTS
    EXAMPLE
    DERIVED FROM
    SEE ALSO
    HISTORY
    ENUM VALUES
    FIELDS
    BUGS
    TODO
    TODOS
    IGNORE
ignore items:
    IGNORE
item order:
    NAME
    PURPOSE
    COPYRIGHT
    LICENSE
    ATTRIBUTION
    USAGE
    DESCRIPTION
    TAGS
    ENVIRONMENT VARIABLES
    INPUTS
    RETURN VALUES
    ERRORS
    SIDE EFFECTS
    PRECONDITIONS
    POSTCONDITIONS
    INVARIANTS
    SECURITY
    ATTACK SURFACE
    THREATS
    PERFORMANCE
    NOTES
    TESTS
    EXAMPLE
    DERIVED FROM
    SEE ALSO
    HISTORY
    BUGS
    TODO
    TODOS
    ENUM VALUES
    FIELDS
source items:
    ENUM VALUES
    FIELDS
preformatted items:
format items:
    NOTES
options:
    --src .
    --doc htmldocs/index
#    --css ./doc/robodoc.css
    --index
    --sections
    --singledoc
    --html
    --internal
    --tabsize 2
    --nogeneratedwith
    --sectionnameonly
    --syntaxcolors
headertypes:
    B  "Build Modules"      robo_build_modules   3
    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:
    dep
    build
    issues
    todo
    .git
    .history
    htmldocs
accept files:
header markers:
    /****
    #****
remark markers:
    *
    ##
    #*
end markers:
    ****
    /****
    #****
header separate characters:
header ignore characters:
remark begin markers:
    /*
    #[
remark end markers:
    */
    ]#
source line comments:
    //
    #
keywords: