source: installer/ogGenerateDoc.sh @ 56742db

918-git-images-111dID-1020_logrotateBugID-1037_Mostrar.TipoDisco.WebID-1038_Muestra.el.numero.de.ordenadoresID-1039_Asignar_Disco.Particion.Imagen.AccesoRemotoID-824_Iniciar.Sistema.Restauradoconfigfiledevel-ogadmserver-for-masterdisk-imagemainmaster-1037opengnsys-1.1.1dprepjlinkqndtestwebconsole3
Last change on this file since 56742db was 9815cac, checked in by Ramón M. Gómez <ramongomez@…>, 6 years ago

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