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