source: installer/ogGenerateDoc.sh @ eb4614b

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 eb4614b was ead38fb, checked in by ramon <ramongomez@…>, 15 years ago

Mensajes y errores para gestión de caché; incluir versión por defecto al generar documentación Doxygen.

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