Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/orxonox/trunk/doc/orxodox.singleFile.pl @ 3446

Last change on this file since 3446 was 3445, checked in by bensch, 20 years ago

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