Extracting Documentation with ROBODocNow that you have prepared your source code for use with
ROBODoc you are ready to extract the documentation. There are
several choices to be made.Single document or many smaller documentsFirst of all, ROBODoc can be used in three modes.multidoc -- in this mode ROBODoc scans
all the source files in your source directory and creates a
separate document file for each of these in a document directory.
The document directory is created automatically. Its structure is
a mirror of the structure of your source directory.singledoc -- in this mode ROBODoc scans all the source
files in your source directory and creates a single documentation
file that contains all the documentation extracted from your
source files. singlefile -- in this mode ROBODoc scans a single source
file and creates a single documentation file.multidocThe multidoc mode is useful to create browsable documents.
For instance many small HTML files that can be viewed with a
web-browser. This mode requires the following arguments:robodoc
--src source directory
--doc document directory
--multidoc
other options
An additional option that is useful with this mode is
, this creates a series of index files,
one for each header type.singledoc The singledoc mode is useful to create bulk documentation
that can be incorporated in other documents, or that can be
delivered to a client as a single document. For instance a file
created in RTF format can be included into a larger design
document written in Word format. This mode requires the following
arguments:robodoc
--src source directory
--doc document file without extension
--singledoc
other optionsAn additional option that is useful with this mode is
, this causes the headers to follow a
section layout based on the module element hierarchy defined in the
header name.singlefileThe singlefile mode is not very useful. It is mainly used
for debugging purposes. This mode requires the following
arguments:robodoc
--src source file
--doc document file
--singlefile
other options
Output formatsYour next choice is the output format. ROBODoc can create
documentation in several formats:HTML, option RTF, option LaTeX, option XML DocBook, option What format to use depends on your wishes. If you want a
single printable document, use LaTeX or XML DocBook. If you want
a document that can be included into a larger (Word) document use
RTF. If you want something that is browsable use HTML, or use XML
DocBook and then convert it to HTML.