OptionsThe behavior of ROBODoc can be further fine-tune with a large number of
options.-cShow the copyright message.--cmodeUse ANSI C grammar in SOURCE items and use this
for syntax highlighting (HTML only).--css Use the content of the specified file to create the
robodoc.css. The content of the file is
copied into robodoc.css. --dbxmlGenerate documentation in XML DocBook format.--debugWorks like --tell, bug gives a lot more information.--docDefine the path to the documentation directory or
documentation file. A path can start with
./ or /. Do not use
.. in the path. The documentation
directory can be a subdirectory of the source directory,
or be parallel to the source directory,
however they can not be equal. So
--src ./sources
together with
--doc ./documents
is fine,
but
--src ./Everything
together with
--doc ./Everything
is not.
--doctype_nameDocBook output requires a <!DOCTYPE> tag.
With this option you can specify your own version of it. You have
to use it in combination with --doctype_location.
An example:
robodoc --src test --doc test
--doctype_location "-//OASIS//DTD Simplified DocBook XML V1.1//EN"
--doctype_name docbook-simple/sdocbook.dtd
--dbxml
results in the following docbook file with the following head:
<!DOCTYPE article PUBLIC "-//OASIS//DTD Simplified DocBook XML V1.1//EN"
"docbook-simple/sdocbook.dtd">
--doctype_locationSee --doctype_name.--headlessDo not create the head of a document. This allows you to
create documents that can be included in other documents, or
to which you can add your own style.For html output this means that no
<html><head> ..... <body>
is generated.
For LaTeX output this means none of the document
initialization code is generated, such as
\documentclass{article} or
\begin{document} is generated. If you use
this option in combination with
you can use \include or
\input commands to include the ROBODoc
generated documents in a larger document.For XML DocBook output this means no
<!DOCTYPE>,
<article>, and
<articleinfo> is generated.
--first_section_levelMake the first section start at the specified level
instead of 1. This is useful if you want to include the
generated documentation in another document.
--footlessDo not create the foot of a document. This allows you to
create documents that can be included in other documents, or
to which you can add your own style.For html output this means that no
</body></html>
is generated.
For LaTeX output this means no
\end{document} is generated.
For XML DocBook output this means no
</article> is generated.
--htmlGenerate documentation in HTML format.--ignore_case_when_linkingIgnore differences in case when creating cross links.
This is handy for languages such as Fortran or Pascal, but
in most cases it is better not to use it.--internalAlso include headers marked internal.--internalonlyOnly include headers marked internal.--indexAlso create a master index file.--lock Per source file robodoc locks on the first header marker
it finds and will recognize only that particular header marker
for the remaining part of the file. In addition it locks on
the first remark marker in each header and will recognize only
that particular remark marker for the remaining part of the
header. --multidocGenerate one document per source file, and copy the
directory hierarchy.--nosourceDo not include the SOURCE items.--no_subdirectoriesDo not create any subdirectories in the documentation directory
instead write all the documentation files in the root directory. The root directory is the one specified with .--nodescDo not scan any subdirectories, scan only the top level
directory of the source tree.--nosortDo not sort the headers when generating the
documentation. The headers will appear in the same order in
the documentation as they appear in the source code.--nopreWith this option ROBODoc does not generate preformatted
text when creating the item documentation. (Using
the <PRE> and
</PRE> construction in HTML format
for instance). Instead ROBODoc tries to deduce
the formatting from the indentation and special
characters. See . This creates much better
looking documentation.
--nogeneratedwithDo not add the "generated with robodoc" message at the
top of each documentation file.--one_file_per_headerCreate a separate documentation file for each header.
--rcUse the specified file instead of robodoc.rc.
--rtfGenerate documentation in RTF format.--sectionsCreate sections based on the module hierarchy.--sectionnameonlyROBODoc generates the section headers with names only,
no chapter numbers, no parent section names.--singledoc Define the documentation directory or documentation
file.--singlefile Generate a single document from a single file --src Define the path for the source directory or source
file. The path can start with ./ or
/. Do not use .. in the
path. --tabsizeLets you specify the tab size.--tabstopsSpecify tab stop locations in a comma separated list.
Example:
--tocAdd a table of contents. This works in multidoc mode as
well as singledoc mode.--latexGenerate documentation in LaTeX format.--tellROBODoc tells you what steps it is taking.--documenttitleSpecify the Title of the whole documentation.--altlatexAlternate LaTeX file format
(bigger / clearer than normal).
--latexpartsMake the first module level as PART
in LaTeX output
(Gives you one more subsection level).--syntaxcolors_enableEnable only specific syntax highlighting features in
SOURCE items (HTML only).Usage:
-- Enable highlighting of "string literals"
-- Enable highlighting of 'string literals'
-- Enable highlighting of comments that span until the end of lines
(See )
-- Enable highlighting of block comments
(See )
-- Enable highlighting of keywords
(See )
-- Enable highlighting of non alphanumeric characters
(like: #, $, %, etc...)
You don't need this if you have the
option specified.
See also the
option.
--syntaxcolorsTurn on all syntax highlighting features in SOURCE
items (HTML only).This option equals to:
You don't need this if you have the
option specified.
See also the
option.
--dotnameSpecify the name (and path / options) of
DOT tool.See .--masterindexSpecify the title and filename of the master index page
Usage:
Example:
--sourceindexSpecify the title and filename of the source files index
pageUsage:
Example:
--header_breaksIf a header has multiple names, ROBODoc can insert line breaks after every
specified number of header names to improve readability. If you do not specify this
option, ROBODoc will insert a line break after every two header names. Set it to
zero to disable the line breaks.
Example: