1 | #!/usr/bin/perl |
---|
2 | |
---|
3 | $inputFiles = @ARGV[0]; |
---|
4 | $tempDoxFile = "TMPorxodox"; |
---|
5 | |
---|
6 | print "Generating temporary Documentation File\n"; |
---|
7 | |
---|
8 | unless (open (DOXfile, ">$tempDoxFile")) |
---|
9 | { |
---|
10 | die("cannot open file\n"); |
---|
11 | } |
---|
12 | |
---|
13 | $processFiles = ""; |
---|
14 | |
---|
15 | $inputFiles =~ s/\.cc$//; |
---|
16 | $inputFiles =~ s/\.h$//; |
---|
17 | |
---|
18 | $inputFiles =~ s/$/\.h/; |
---|
19 | $processFiles = "$processFiles $inputFiles"; |
---|
20 | $inputFiles =~ s/\.h$/\.cc/; |
---|
21 | $processFiles = "$processFiles $inputFiles"; |
---|
22 | |
---|
23 | |
---|
24 | #if (-e $processFiles) |
---|
25 | # { |
---|
26 | # print "Using file $processFiles as input\n"; |
---|
27 | # } |
---|
28 | #else |
---|
29 | # { |
---|
30 | # die("File $processFiles does not exist\n"); |
---|
31 | # } |
---|
32 | |
---|
33 | |
---|
34 | |
---|
35 | print DOXfile "# THIS IS A DEFAULT FILE FOR DOXYGEN DOCUMENTATION"; |
---|
36 | |
---|
37 | printf DOXfile "# Doxyfile 1.3.7 \ |
---|
38 | ## SAMPLE FILE (to be executed from orxonox/trunk/) \ |
---|
39 | \ |
---|
40 | #--------------------------------------------------------------------------- \ |
---|
41 | # Project related configuration options \ |
---|
42 | #--------------------------------------------------------------------------- \ |
---|
43 | PROJECT_NAME = Orxonox \ |
---|
44 | PROJECT_NUMBER = 1 \ |
---|
45 | OUTPUT_DIRECTORY = doxygen/ \ |
---|
46 | CREATE_SUBDIRS = YES \ |
---|
47 | OUTPUT_LANGUAGE = English \ |
---|
48 | USE_WINDOWS_ENCODING = YES \ |
---|
49 | BRIEF_MEMBER_DESC = YES \ |
---|
50 | REPEAT_BRIEF = YES \ |
---|
51 | ABBREVIATE_BRIEF = \ |
---|
52 | ALWAYS_DETAILED_SEC = NO \ |
---|
53 | INLINE_INHERITED_MEMB = NO \ |
---|
54 | FULL_PATH_NAMES = NO \ |
---|
55 | STRIP_FROM_PATH = \ |
---|
56 | STRIP_FROM_INC_PATH = \ |
---|
57 | SHORT_NAMES = NO \ |
---|
58 | JAVADOC_AUTOBRIEF = NO \ |
---|
59 | MULTILINE_CPP_IS_BRIEF = NO \ |
---|
60 | DETAILS_AT_TOP = NO \ |
---|
61 | INHERIT_DOCS = YES \ |
---|
62 | DISTRIBUTE_GROUP_DOC = NO \ |
---|
63 | TAB_SIZE = 8 \ |
---|
64 | ALIASES = \ |
---|
65 | OPTIMIZE_OUTPUT_FOR_C = NO \ |
---|
66 | OPTIMIZE_OUTPUT_JAVA = NO \ |
---|
67 | SUBGROUPING = YES \ |
---|
68 | #--------------------------------------------------------------------------- \ |
---|
69 | # Build related configuration options \ |
---|
70 | #--------------------------------------------------------------------------- \ |
---|
71 | EXTRACT_ALL = NO \ |
---|
72 | EXTRACT_PRIVATE = YES \ |
---|
73 | EXTRACT_STATIC = YES \ |
---|
74 | EXTRACT_LOCAL_CLASSES = YES \ |
---|
75 | EXTRACT_LOCAL_METHODS = NO \ |
---|
76 | HIDE_UNDOC_MEMBERS = NO \ |
---|
77 | HIDE_UNDOC_CLASSES = NO \ |
---|
78 | HIDE_FRIEND_COMPOUNDS = NO \ |
---|
79 | HIDE_IN_BODY_DOCS = NO \ |
---|
80 | INTERNAL_DOCS = NO \ |
---|
81 | CASE_SENSE_NAMES = YES \ |
---|
82 | HIDE_SCOPE_NAMES = NO \ |
---|
83 | SHOW_INCLUDE_FILES = YES \ |
---|
84 | INLINE_INFO = YES \ |
---|
85 | SORT_MEMBER_DOCS = YES \ |
---|
86 | SORT_BRIEF_DOCS = NO \ |
---|
87 | SORT_BY_SCOPE_NAME = NO \ |
---|
88 | GENERATE_TODOLIST = YES \ |
---|
89 | GENERATE_TESTLIST = YES \ |
---|
90 | GENERATE_BUGLIST = YES \ |
---|
91 | GENERATE_DEPRECATEDLIST= YES \ |
---|
92 | ENABLED_SECTIONS = \ |
---|
93 | MAX_INITIALIZER_LINES = 30 \ |
---|
94 | SHOW_USED_FILES = YES \ |
---|
95 | #--------------------------------------------------------------------------- \ |
---|
96 | # configuration options related to warning and progress messages \ |
---|
97 | #--------------------------------------------------------------------------- \ |
---|
98 | QUIET = YES \ |
---|
99 | WARNINGS = YES \ |
---|
100 | WARN_IF_UNDOCUMENTED = YES \ |
---|
101 | WARN_IF_DOC_ERROR = YES \ |
---|
102 | WARN_FORMAT = \"\$file:\$line: \$text\" \ |
---|
103 | WARN_LOGFILE = \ |
---|
104 | #--------------------------------------------------------------------------- \ |
---|
105 | # configuration options related to the input files \ |
---|
106 | #--------------------------------------------------------------------------- \ |
---|
107 | INPUT = $processFiles \ |
---|
108 | FILE_PATTERNS = \ |
---|
109 | RECURSIVE = NO \ |
---|
110 | EXCLUDE = \ |
---|
111 | EXCLUDE_SYMLINKS = NO \ |
---|
112 | EXCLUDE_PATTERNS = \ |
---|
113 | EXAMPLE_PATH = \ |
---|
114 | EXAMPLE_PATTERNS = \ |
---|
115 | EXAMPLE_RECURSIVE = NO \ |
---|
116 | IMAGE_PATH = \ |
---|
117 | INPUT_FILTER = \ |
---|
118 | FILTER_SOURCE_FILES = NO \ |
---|
119 | #--------------------------------------------------------------------------- \ |
---|
120 | # configuration options related to source browsing \ |
---|
121 | #--------------------------------------------------------------------------- \ |
---|
122 | SOURCE_BROWSER = NO \ |
---|
123 | INLINE_SOURCES = NO \ |
---|
124 | STRIP_CODE_COMMENTS = YES \ |
---|
125 | REFERENCED_BY_RELATION = YES \ |
---|
126 | REFERENCES_RELATION = YES \ |
---|
127 | VERBATIM_HEADERS = YES \ |
---|
128 | #--------------------------------------------------------------------------- \ |
---|
129 | # configuration options related to the alphabetical class index \ |
---|
130 | #--------------------------------------------------------------------------- \ |
---|
131 | ALPHABETICAL_INDEX = NO \ |
---|
132 | COLS_IN_ALPHA_INDEX = 5 \ |
---|
133 | IGNORE_PREFIX = \ |
---|
134 | #--------------------------------------------------------------------------- \ |
---|
135 | # configuration options related to the HTML output \ |
---|
136 | #--------------------------------------------------------------------------- \ |
---|
137 | GENERATE_HTML = YES \ |
---|
138 | HTML_OUTPUT = html \ |
---|
139 | HTML_FILE_EXTENSION = .html \ |
---|
140 | HTML_HEADER = \ |
---|
141 | HTML_FOOTER = \ |
---|
142 | HTML_STYLESHEET = \ |
---|
143 | HTML_ALIGN_MEMBERS = YES \ |
---|
144 | GENERATE_HTMLHELP = NO \ |
---|
145 | CHM_FILE = \ |
---|
146 | HHC_LOCATION = \ |
---|
147 | GENERATE_CHI = NO \ |
---|
148 | BINARY_TOC = NO \ |
---|
149 | TOC_EXPAND = NO \ |
---|
150 | DISABLE_INDEX = NO \ |
---|
151 | ENUM_VALUES_PER_LINE = 4 \ |
---|
152 | GENERATE_TREEVIEW = NO \ |
---|
153 | TREEVIEW_WIDTH = 250 \ |
---|
154 | #--------------------------------------------------------------------------- \ |
---|
155 | # configuration options related to the LaTeX output \ |
---|
156 | #--------------------------------------------------------------------------- \ |
---|
157 | GENERATE_LATEX = NO \ |
---|
158 | LATEX_OUTPUT = latex \ |
---|
159 | LATEX_CMD_NAME = latex \ |
---|
160 | MAKEINDEX_CMD_NAME = makeindex \ |
---|
161 | COMPACT_LATEX = NO \ |
---|
162 | PAPER_TYPE = a4wide \ |
---|
163 | EXTRA_PACKAGES = \ |
---|
164 | LATEX_HEADER = \ |
---|
165 | PDF_HYPERLINKS = NO \ |
---|
166 | USE_PDFLATEX = NO \ |
---|
167 | LATEX_BATCHMODE = NO \ |
---|
168 | LATEX_HIDE_INDICES = NO \ |
---|
169 | #--------------------------------------------------------------------------- \ |
---|
170 | # configuration options related to the RTF output \ |
---|
171 | #--------------------------------------------------------------------------- \ |
---|
172 | GENERATE_RTF = NO \ |
---|
173 | RTF_OUTPUT = rtf \ |
---|
174 | COMPACT_RTF = NO \ |
---|
175 | RTF_HYPERLINKS = NO \ |
---|
176 | RTF_STYLESHEET_FILE = \ |
---|
177 | RTF_EXTENSIONS_FILE = \ |
---|
178 | #--------------------------------------------------------------------------- \ |
---|
179 | # configuration options related to the man page output \ |
---|
180 | #--------------------------------------------------------------------------- \ |
---|
181 | GENERATE_MAN = NO \ |
---|
182 | MAN_OUTPUT = man \ |
---|
183 | MAN_EXTENSION = .3 \ |
---|
184 | MAN_LINKS = NO \ |
---|
185 | #--------------------------------------------------------------------------- \ |
---|
186 | # configuration options related to the XML output \ |
---|
187 | #--------------------------------------------------------------------------- \ |
---|
188 | GENERATE_XML = NO \ |
---|
189 | XML_OUTPUT = xml \ |
---|
190 | XML_SCHEMA = \ |
---|
191 | XML_DTD = \ |
---|
192 | XML_PROGRAMLISTING = YES \ |
---|
193 | #--------------------------------------------------------------------------- \ |
---|
194 | # configuration options for the AutoGen Definitions output \ |
---|
195 | #--------------------------------------------------------------------------- \ |
---|
196 | GENERATE_AUTOGEN_DEF = NO \ |
---|
197 | #--------------------------------------------------------------------------- \ |
---|
198 | # configuration options related to the Perl module output \ |
---|
199 | #--------------------------------------------------------------------------- \ |
---|
200 | GENERATE_PERLMOD = NO \ |
---|
201 | PERLMOD_LATEX = NO \ |
---|
202 | PERLMOD_PRETTY = YES \ |
---|
203 | PERLMOD_MAKEVAR_PREFIX = \ |
---|
204 | #--------------------------------------------------------------------------- \ |
---|
205 | # Configuration options related to the preprocessor \ |
---|
206 | #--------------------------------------------------------------------------- \ |
---|
207 | ENABLE_PREPROCESSING = YES \ |
---|
208 | MACRO_EXPANSION = NO \ |
---|
209 | EXPAND_ONLY_PREDEF = NO \ |
---|
210 | SEARCH_INCLUDES = YES \ |
---|
211 | INCLUDE_PATH = \ |
---|
212 | INCLUDE_FILE_PATTERNS = \ |
---|
213 | PREDEFINED = \ |
---|
214 | EXPAND_AS_DEFINED = \ |
---|
215 | SKIP_FUNCTION_MACROS = YES \ |
---|
216 | #--------------------------------------------------------------------------- \ |
---|
217 | # Configuration::additions related to external references \ |
---|
218 | #--------------------------------------------------------------------------- \ |
---|
219 | TAGFILES = \ |
---|
220 | GENERATE_TAGFILE = \ |
---|
221 | ALLEXTERNALS = NO \ |
---|
222 | EXTERNAL_GROUPS = YES \ |
---|
223 | PERL_PATH = /usr/bin/perl \ |
---|
224 | #--------------------------------------------------------------------------- \ |
---|
225 | # Configuration options related to the dot tool \ |
---|
226 | #--------------------------------------------------------------------------- \ |
---|
227 | CLASS_DIAGRAMS = YES \ |
---|
228 | HIDE_UNDOC_RELATIONS = YES \ |
---|
229 | HAVE_DOT = NO \ |
---|
230 | CLASS_GRAPH = YES \ |
---|
231 | COLLABORATION_GRAPH = YES \ |
---|
232 | UML_LOOK = NO \ |
---|
233 | TEMPLATE_RELATIONS = NO \ |
---|
234 | INCLUDE_GRAPH = YES \ |
---|
235 | INCLUDED_BY_GRAPH = YES \ |
---|
236 | CALL_GRAPH = NO \ |
---|
237 | GRAPHICAL_HIERARCHY = YES \ |
---|
238 | DOT_IMAGE_FORMAT = png \ |
---|
239 | DOT_PATH = \ |
---|
240 | DOTFILE_DIRS = \ |
---|
241 | MAX_DOT_GRAPH_WIDTH = 1024 \ |
---|
242 | MAX_DOT_GRAPH_HEIGHT = 1024 \ |
---|
243 | MAX_DOT_GRAPH_DEPTH = 0 \ |
---|
244 | GENERATE_LEGEND = YES \ |
---|
245 | DOT_CLEANUP = YES \ |
---|
246 | #--------------------------------------------------------------------------- \ |
---|
247 | # Configuration::additions related to the search engine \ |
---|
248 | #--------------------------------------------------------------------------- \ |
---|
249 | SEARCHENGINE = NO \ |
---|
250 | \ |
---|
251 | "; |
---|
252 | |
---|
253 | close DOXfile; |
---|
254 | |
---|
255 | print "Generating Documentation of $processFiles\n"; |
---|
256 | exec("doxygen $tempDoxFile"); |
---|