Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/orxonox/trunk/doc/orxodox.checkFiles.pl @ 3447

Last change on this file since 3447 was 3447, checked in by bensch, 19 years ago

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