source: installer/ogGenerateDoc.sh @ 311532f

918-git-images-111dconfigfileconfigure-oglivegit-imageslgromero-new-oglivemainmaint-cronmount-efivarfsmultivmmultivm-ogboot-installerogClonningEngineogboot-installer-jenkinsoglive-ipv6test-python-scriptsticket-301ticket-50ticket-50-oldticket-577ticket-585ticket-611ticket-612ticket-693ticket-700ubu24tplunification2use-local-agent-oglivevarios-instalacionwebconsole3
Last change on this file since 311532f was 7b64958, checked in by ramon <ramongomez@…>, 15 years ago

Fichero opengnsys-0.9-r662; mejor compatibilidad Doxygen para Trac.

git-svn-id: https://opengnsys.es/svn/trunk@662 a21b9725-9963-47de-94b9-378ad31fedc9
  • Property mode set to 100755
File size: 11.7 KB
Line 
1#!/bin/bash
2#/**  @function ogGenerateDoc: @brief Genera Documentación Doxygen .
3#@param $1 str_pathOrigen del codigo
4#@param $2 str_pathDestino de la documentacion.
5#@param ejemplo ogGenerateDoc /home/adv/workspace/opengnsys/trunk/clients/engine /opt/opengnsys/www/doc
6#@return genera la documentacion en el path indicado como parametro2.
7#@warning  Salidas de errores propia de doxygen
8#@attention
9#@version 1.0       Date: 01/06/2009                 Author Antonio J. Doblas Viso. Universidad de Malaga
10#@note    requiere doxygen y graphviz
11#*/
12#
13if [ $# = 0 ]
14then
15        echo "ogGenerateDoc: Genera Documentación Doxygen"
16        echo "sintaxis: ogGenerateDoc.sh str_PathCodigoFuente str_PathDestinoDocumentacion"
17        echo "sintaxis: ogGenerateDoc.sh /home/adv/workspace/opengnsys/trunk/clients/engine /opt/opengnsys/www/doc "
18        exit
19fi
20if [ $# = 2 ]
21then
22mkdir -p $2
23cat > /tmp/doxyfile << EOF
24# Doxyfile 1.5.6
25# Fichero para documentar codigo shellscripts linux.
26# Proyecto OpenGnsys
27#---------------------------------------------------------------------------
28# Project related configuration options
29#---------------------------------------------------------------------------
30DOXYFILE_ENCODING      = UTF-8
31PROJECT_NAME           = "Proyecto OpenGnSys"
32PROJECT_NUMBER         = 1.0
33OUTPUT_DIRECTORY       = $2
34CREATE_SUBDIRS         = NO
35OUTPUT_LANGUAGE        = Spanish
36BRIEF_MEMBER_DESC      = YES
37REPEAT_BRIEF           = YES
38ABBREVIATE_BRIEF       = "The $name class" \
39                         "The $name widget" \
40                         "The $name file" \
41                         is \
42                         provides \
43                         specifies \
44                         contains \
45                         represents \
46                         a \
47                         an \
48                         the
49ALWAYS_DETAILED_SEC    = NO
50INLINE_INHERITED_MEMB  = NO
51FULL_PATH_NAMES        = YES
52STRIP_FROM_PATH        = $1
53STRIP_FROM_INC_PATH    =
54SHORT_NAMES            = NO
55JAVADOC_AUTOBRIEF      = NO
56QT_AUTOBRIEF           = NO
57MULTILINE_CPP_IS_BRIEF = NO
58DETAILS_AT_TOP         = NO
59INHERIT_DOCS           = YES
60SEPARATE_MEMBER_PAGES  = NO
61TAB_SIZE               = 8
62ALIASES                =
63OPTIMIZE_OUTPUT_FOR_C  = YES
64OPTIMIZE_OUTPUT_JAVA   = NO
65OPTIMIZE_FOR_FORTRAN   = YES
66OPTIMIZE_OUTPUT_VHDL   = NO
67BUILTIN_STL_SUPPORT    = NO
68CPP_CLI_SUPPORT        = NO
69SIP_SUPPORT            = NO
70IDL_PROPERTY_SUPPORT   = YES
71DISTRIBUTE_GROUP_DOC   = NO
72SUBGROUPING            = YES
73TYPEDEF_HIDES_STRUCT   = NO
74#---------------------------------------------------------------------------
75# Build related configuration options
76#---------------------------------------------------------------------------
77EXTRACT_ALL            = YES
78EXTRACT_PRIVATE        = YES
79EXTRACT_STATIC         = YES
80EXTRACT_LOCAL_CLASSES  = YES
81EXTRACT_LOCAL_METHODS  = NO
82EXTRACT_ANON_NSPACES   = NO
83HIDE_UNDOC_MEMBERS     = NO
84HIDE_UNDOC_CLASSES     = NO
85HIDE_FRIEND_COMPOUNDS  = NO
86HIDE_IN_BODY_DOCS      = NO
87INTERNAL_DOCS          = NO
88CASE_SENSE_NAMES       = YES
89HIDE_SCOPE_NAMES       = NO
90SHOW_INCLUDE_FILES     = YES
91INLINE_INFO            = YES
92SORT_MEMBER_DOCS       = YES
93SORT_BRIEF_DOCS        = NO
94SORT_GROUP_NAMES       = NO
95SORT_BY_SCOPE_NAME     = NO
96GENERATE_TODOLIST      = YES
97GENERATE_TESTLIST      = YES
98GENERATE_BUGLIST       = YES
99GENERATE_DEPRECATEDLIST= YES
100ENABLED_SECTIONS       =
101MAX_INITIALIZER_LINES  = 30
102SHOW_USED_FILES        = YES
103SHOW_DIRECTORIES       = NO
104SHOW_FILES             = YES
105SHOW_NAMESPACES        = YES
106FILE_VERSION_FILTER    =
107#---------------------------------------------------------------------------
108# configuration options related to warning and progress messages
109#---------------------------------------------------------------------------
110QUIET                  = NO
111WARNINGS               = YES
112WARN_IF_UNDOCUMENTED   = YES
113WARN_IF_DOC_ERROR      = YES
114WARN_NO_PARAMDOC       = NO
115WARN_FORMAT            = "$file:$line: $text"
116WARN_LOGFILE           =
117#---------------------------------------------------------------------------
118# configuration options related to the input files
119#---------------------------------------------------------------------------
120INPUT                  = $1
121INPUT_ENCODING         = UTF-8
122FILE_PATTERNS          = *.c \
123                         *.cc \
124                         *.cxx \
125                         *.cpp \
126                         *.c++ \
127                         *.d \
128                         *.java \
129                         *.ii \
130                         *.ixx \
131                         *.ipp \
132                         *.i++ \
133                         *.inl \
134                         *.h \
135                         *.hh \
136                         *.hxx \
137                         *.hpp \
138                         *.h++ \
139                         *.idl \
140                         *.odl \
141                         *.cs \
142                         *.php \
143                         *.php3 \
144                         *.inc \
145                         *.m \
146                         *.mm \
147                         *.dox \
148                         *.py \
149                         *.f90 \
150                         *.f \
151                         *.vhd \
152                         *.vhdl \
153                         *.C \
154                         *.CC \
155                         *.C++ \
156                         *.II \
157                         *.I++ \
158                         *.H \
159                         *.HH \
160                         *.H++ \
161                         *.CS \
162                         *.PHP \
163                         *.PHP3 \
164                         *.M \
165                         *.MM \
166                         *.PY \
167                         *.F90 \
168                         *.F \
169                         *.VHD \
170                         *.VHDL \
171                         *.lib \
172                         *.lib
173RECURSIVE              = YES
174EXCLUDE                =
175EXCLUDE_SYMLINKS       = NO
176EXCLUDE_PATTERNS       =
177EXCLUDE_SYMBOLS        =
178EXAMPLE_PATH           =
179EXAMPLE_PATTERNS       = *
180EXAMPLE_RECURSIVE      = NO
181IMAGE_PATH             =
182INPUT_FILTER           =
183FILTER_PATTERNS        =
184FILTER_SOURCE_FILES    = NO
185#---------------------------------------------------------------------------
186# configuration options related to source browsing
187#---------------------------------------------------------------------------
188SOURCE_BROWSER         = YES
189INLINE_SOURCES         = NO
190STRIP_CODE_COMMENTS    = YES
191REFERENCED_BY_RELATION = YES
192REFERENCES_RELATION    = YES
193REFERENCES_LINK_SOURCE = YES
194USE_HTAGS              = NO
195VERBATIM_HEADERS       = YES
196#---------------------------------------------------------------------------
197# configuration options related to the alphabetical class index
198#---------------------------------------------------------------------------
199ALPHABETICAL_INDEX     = NO
200COLS_IN_ALPHA_INDEX    = 5
201IGNORE_PREFIX          =
202#---------------------------------------------------------------------------
203# configuration options related to the HTML output
204#---------------------------------------------------------------------------
205GENERATE_HTML          = YES
206HTML_OUTPUT            = html
207HTML_FILE_EXTENSION    = .html
208HTML_HEADER            =
209HTML_FOOTER            =
210HTML_STYLESHEET        =
211HTML_ALIGN_MEMBERS     = YES
212GENERATE_HTMLHELP      = NO
213GENERATE_DOCSET        = NO
214DOCSET_FEEDNAME        = "Doxygen generated docs"
215DOCSET_BUNDLE_ID       = org.doxygen.Project
216HTML_DYNAMIC_SECTIONS  = NO
217CHM_FILE               =
218HHC_LOCATION           =
219GENERATE_CHI           = NO
220CHM_INDEX_ENCODING     =
221BINARY_TOC             = NO
222TOC_EXPAND             = NO
223DISABLE_INDEX          = NO
224ENUM_VALUES_PER_LINE   = 4
225GENERATE_TREEVIEW      = ALL
226TREEVIEW_WIDTH         = 250
227FORMULA_FONTSIZE       = 10
228#---------------------------------------------------------------------------
229# configuration options related to the LaTeX output
230#---------------------------------------------------------------------------
231GENERATE_LATEX         = NO
232LATEX_OUTPUT           = latex
233LATEX_CMD_NAME         = latex
234MAKEINDEX_CMD_NAME     = makeindex
235COMPACT_LATEX          = NO
236PAPER_TYPE             = a4wide
237EXTRA_PACKAGES         =
238LATEX_HEADER           =
239PDF_HYPERLINKS         = YES
240USE_PDFLATEX           = YES
241LATEX_BATCHMODE        = NO
242LATEX_HIDE_INDICES     = NO
243#---------------------------------------------------------------------------
244# configuration options related to the RTF output
245#---------------------------------------------------------------------------
246GENERATE_RTF           = YES
247RTF_OUTPUT             = rtf
248COMPACT_RTF            = YES
249RTF_HYPERLINKS         = YES
250RTF_STYLESHEET_FILE    =
251RTF_EXTENSIONS_FILE    =
252#---------------------------------------------------------------------------
253# configuration options related to the man page output
254#---------------------------------------------------------------------------
255GENERATE_MAN           = YES
256MAN_OUTPUT             = man
257MAN_EXTENSION          = .3
258MAN_LINKS              = YES
259#---------------------------------------------------------------------------
260# configuration options related to the XML output
261#---------------------------------------------------------------------------
262GENERATE_XML           = NO
263XML_OUTPUT             = xml
264XML_SCHEMA             =
265XML_DTD                =
266XML_PROGRAMLISTING     = YES
267#---------------------------------------------------------------------------
268# configuration options for the AutoGen Definitions output
269#---------------------------------------------------------------------------
270GENERATE_AUTOGEN_DEF   = NO
271#---------------------------------------------------------------------------
272# configuration options related to the Perl module output
273#---------------------------------------------------------------------------
274GENERATE_PERLMOD       = YES
275PERLMOD_LATEX          = NO
276PERLMOD_PRETTY         = YES
277PERLMOD_MAKEVAR_PREFIX =
278#---------------------------------------------------------------------------
279# Configuration options related to the preprocessor
280#---------------------------------------------------------------------------
281ENABLE_PREPROCESSING   = YES
282MACRO_EXPANSION        = YES
283EXPAND_ONLY_PREDEF     = NO
284SEARCH_INCLUDES        = YES
285INCLUDE_PATH           =
286INCLUDE_FILE_PATTERNS  =
287PREDEFINED             =
288EXPAND_AS_DEFINED      =
289SKIP_FUNCTION_MACROS   = YES
290#---------------------------------------------------------------------------
291# Configuration::additions related to external references
292#---------------------------------------------------------------------------
293TAGFILES               =
294GENERATE_TAGFILE       =
295ALLEXTERNALS           = NO
296EXTERNAL_GROUPS        = YES
297PERL_PATH              = /usr/bin/perl
298#---------------------------------------------------------------------------
299# Configuration options related to the dot tool
300#---------------------------------------------------------------------------
301CLASS_DIAGRAMS         = NO
302MSCGEN_PATH            =
303HIDE_UNDOC_RELATIONS   = YES
304HAVE_DOT               = YES
305DOT_FONTNAME           = FreeSans
306DOT_FONTPATH           =
307CLASS_GRAPH            = YES
308COLLABORATION_GRAPH    = YES
309GROUP_GRAPHS           = YES
310UML_LOOK               = NO
311TEMPLATE_RELATIONS     = NO
312INCLUDE_GRAPH          = YES
313INCLUDED_BY_GRAPH      = YES
314CALL_GRAPH             = YES
315CALLER_GRAPH           = NO
316GRAPHICAL_HIERARCHY    = YES
317DIRECTORY_GRAPH        = YES
318DOT_IMAGE_FORMAT       = png
319DOT_PATH               =
320DOTFILE_DIRS           =
321DOT_GRAPH_MAX_NODES    = 20
322MAX_DOT_GRAPH_DEPTH    = 2
323DOT_TRANSPARENT        = YES
324DOT_MULTI_TARGETS      = NO
325GENERATE_LEGEND        = YES
326DOT_CLEANUP            = YES
327#---------------------------------------------------------------------------
328# Configuration::additions related to the search engine
329#---------------------------------------------------------------------------
330SEARCHENGINE           = NO
331EOF
332
333doxygen /tmp/doxyfile
334fi
Note: See TracBrowser for help on using the repository browser.