1        Command Line Options
2        --------------------
3
4autodoc [-v <level>]
5        -html <out>
6        [-extroot <externroot> -extnsp <externnamespace>]
7        -lg <proglang>
8        [-t <sourcetree>[ <sourcetree> ...]
9        [-d <sourcedir>[ <sourcedir> ...]
10        [-f <sourcefile>[ <sourcefile> ...]
11
12
13    -html <OutputDirectory>
14        Directory where the output will be created.
15
16    -lg <ProgrammingLanguage>
17        Allowed values: "c++" or "idl"
18
19    -extroot <externroot>
20        Only together with "-lg idl" and -extnsp.
21        Links to code entities not found within the current parsed
22        code, will be linked there, but only if -extnsp is given and
23        the linked entity is in the given namespace.
24        <externroot> is a http link, it needs no "http://" at the
25        beginning nor slash at the end.
26
27    -extnsp <externnamespace>
28        Only together with "-lg idl" and -extroot.
29        If a code entity is not found in the current parsed code, but
30        dwells in the namespace (or its children) given here, it is
31        linked into the loc�tion given by -extroot.
32        <externnamespace> is an absolute qualified namespace,
33        starting with "::".
34
35    -t <SourceTree>*
36        Directory with all subdirectories.
37
38    -d <SourceDirectory>*
39        Directory without subdirectories.
40
41    -f <SourceFile>*
42        Any file. Here also files with extensions not matching the
43        language are accepted.
44
45    -I:<ResponseFile>
46        Each line in the response file has to have one command line
47        option. No whitespace at start of line.
48
49    -C:<ConfigurationFile>
50        Format see below.
51
52    -v <VerboseLevel>
53        Only for debugging. Bits 1, 2 and 4 in any combination give
54        different output.
55
56    -h
57        Displays help.
58    -?
59        Displays help.
60
61
62
63
64
65        Command Line Options especially for the OpenOffice.org SDK
66        ----------------------------------------------------------
67
68    -dvgroot <DevelopersGuide>
69        Root directory of the SDK Developers Guide.
70
71    -dvgfile <ReferenceFile>
72        File with references to the SDK Developers Guide.
73
74    -sincefile <@since-AssociationFile>
75        File that maps OpenOffice versions to the wished displayed version names.
76
77    -idlref <IdlDocumentationRoot> <Namespace[,Namespace ...]>
78        Gives the outputdirectory of an IDL documentation, where
79        symbols not found in the currently parsed namespaces of C++
80        or Java can be found.
81
82
83
84        Configure File Format
85        ---------------------
86
87<AutodocConfiguration>
88    <RepositoryName></RepositoryName>
89        // Base name of the binary repository files.
90        // Has to be a valid file name.
91
92    <HtmlOutputTitle></HtmlOutputTitle>
93        // Title on the "welcome page" of the created HTML documentation.
94        // Can be any text.
95
96    <CppExtensions></CppExtensions>
97        // Overwrites the default. Default is: .hxx .h .hpp
98        // Format: File extensions with a dot in front, like ".hcc".
99
100    <IdlExtensions></IdlExtensions>
101        // Overwrites the default. Default is: .idl
102        // Format: File extensions with a dot in front, like ".txt".
103
104    <CppDocu html="(on|off) off"/>
105
106    <IdlDocu html="(on|off) on"/>
107
108</AutodocConfiguration>
109
110
111
112
113
114
115        Historical Command Line Options
116        -------------------------------
117
118autodoc.exe
119    [ -v <VerboseNr> ]
120    -html <OutputDirectory>
121    {
122        [ -parse ]
123	[ -name <RepositoryName> ]
124        -lg <ProgrammingLanguage>
125        {
126            [ -p <ProjectName> <ProjectRootDirectory> ]
127            {
128                -t <SourceDirectory>*
129                -d <SourceDirectory>*
130                -f <SourceFile>*
131            }+
132        }+
133    }
134
135Legend:
136    <Text>
137    	command line parameter
138    [ ]
139    	optional
140    { }
141    	Block of connected options.
142    The sequence of not connected options does not matter. So the -html or -v options can be used before or after all the parsing options.
143    +
144    	once or more times
145    *
146    	none or more times
147
148
149Explanation of the Options
150    -v <VerboseNr> 	Only for debugging. Bits 1, 2 and 4 in any combination give different output.
151    -html <OutputDirectory>
152    	Gives the directory, where a HTML version of the docu shall be generated.
153    -parse 	Starts the block, where all the parse options are given. This can be omitted, because the parse options are identifiable without it, but it may make a commandline more readable.
154    -name <RepositoryName> 	This name appears as title of the documentation (currently only in the in the C++ version).
155    -lg <ProgrammingLanguage>
156
157
158    Possible values are:
159
160    c++
161        This parses all files with the endings .hxx and .h .
162    idl
163        This parses all files with the ending .idl .
164
165    -p with -t/-d/-f: 	If there are more than one project, the -p option is required for each one.
166
167    The directory given wit the -p option is the root directory of the project.
168    If there is no -p option, the working directory is seen as root.
169
170    All paths given with -t/-d/-f are relative to that root directory. It is possible to use "." as argument for -t or -d.
171
172    Each of -t/-d/-f can have several arguments:
173    One could write "-f file1.hxx file2.hxx file_xyz.hxx"
174    After each -p (or after -lg, if there is no -p option), there has to be at least one of the following three:
175    -t 	Tree, which means: include subdirectories
176    -d 	Directory, which means: no subdirectories
177    -f 	File", which means: single file name with ending.
178    This option also allows to parse some files with an ending different from those, the -lg option implies.
179
180
181
182