source: installer/ogGenerateDoc.sh

qndtest
Last change on this file was 834158f, checked in by Ramón M. Gómez <ramongomez@…>, 6 years ago

#853: Updating Doxygen configuration to resolve compatibility problems.
  • Property mode set to 100755
File size: 13.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"
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.8.13
29
30#---------------------------------------------------------------------------
31# Project related configuration options
32#---------------------------------------------------------------------------
33DOXYFILE_ENCODING      = UTF-8
34PROJECT_NAME           = $PROJECT
35PROJECT_NUMBER         = $VERSION
36PROJECT_BRIEF          =
37PROJECT_LOGO           = $(dirname "$0")/../doc/opengnsys-logo.png
38OUTPUT_DIRECTORY       = $2
39CREATE_SUBDIRS         = NO
40ALLOW_UNICODE_NAMES    = NO
41OUTPUT_LANGUAGE        = Spanish
42BRIEF_MEMBER_DESC      = YES
43REPEAT_BRIEF           = YES
44ABBREVIATE_BRIEF       = "The $name class" \
45                         "The $name widget" \
46                         "The $name file" \
47                         is \
48                         provides \
49                         specifies \
50                         contains \
51                         represents \
52                         a \
53                         an \
54                         the
55ALWAYS_DETAILED_SEC    = NO
56INLINE_INHERITED_MEMB  = NO
57FULL_PATH_NAMES        = YES
58STRIP_FROM_PATH        = $1
59STRIP_FROM_INC_PATH    =
60SHORT_NAMES            = NO
61JAVADOC_AUTOBRIEF      = NO
62QT_AUTOBRIEF           = NO
63MULTILINE_CPP_IS_BRIEF = NO
64INHERIT_DOCS           = YES
65SEPARATE_MEMBER_PAGES  = NO
66TAB_SIZE               = 4
67ALIASES                =
68TCL_SUBST              =
69OPTIMIZE_OUTPUT_FOR_C  = YES
70OPTIMIZE_OUTPUT_JAVA   = NO
71OPTIMIZE_FOR_FORTRAN   = NO
72OPTIMIZE_OUTPUT_VHDL   = NO
73EXTENSION_MAPPING      = lib=c
74MARKDOWN_SUPPORT       = YES
75TOC_INCLUDE_HEADINGS   = 0
76AUTOLINK_SUPPORT       = YES
77BUILTIN_STL_SUPPORT    = NO
78CPP_CLI_SUPPORT        = NO
79SIP_SUPPORT            = NO
80IDL_PROPERTY_SUPPORT   = YES
81DISTRIBUTE_GROUP_DOC   = NO
82GROUP_NESTED_COMPOUNDS = NO
83SUBGROUPING            = YES
84INLINE_GROUPED_CLASSES = NO
85INLINE_SIMPLE_STRUCTS  = NO
86TYPEDEF_HIDES_STRUCT   = NO
87LOOKUP_CACHE_SIZE      = 0
88#---------------------------------------------------------------------------
89# Build related configuration options
90#---------------------------------------------------------------------------
91EXTRACT_ALL            = YES
92EXTRACT_PRIVATE        = YES
93EXTRACT_PACKAGE        = NO
94EXTRACT_STATIC         = YES
95EXTRACT_LOCAL_CLASSES  = YES
96EXTRACT_LOCAL_METHODS  = NO
97EXTRACT_ANON_NSPACES   = NO
98HIDE_UNDOC_MEMBERS     = NO
99HIDE_UNDOC_CLASSES     = NO
100HIDE_FRIEND_COMPOUNDS  = NO
101HIDE_IN_BODY_DOCS      = NO
102INTERNAL_DOCS          = NO
103CASE_SENSE_NAMES       = YES
104HIDE_SCOPE_NAMES       = NO
105HIDE_COMPOUND_REFERENCE= NO
106SHOW_INCLUDE_FILES     = YES
107SHOW_GROUPED_MEMB_INC  = NO
108FORCE_LOCAL_INCLUDES   = NO
109INLINE_INFO            = YES
110SORT_MEMBER_DOCS       = YES
111SORT_BRIEF_DOCS        = NO
112SORT_MEMBERS_CTORS_1ST = NO
113SORT_GROUP_NAMES       = NO
114SORT_BY_SCOPE_NAME     = NO
115STRICT_PROTO_MATCHING  = NO
116GENERATE_TODOLIST      = YES
117GENERATE_TESTLIST      = YES
118GENERATE_BUGLIST       = YES
119GENERATE_DEPRECATEDLIST= YES
120ENABLED_SECTIONS       =
121MAX_INITIALIZER_LINES  = 30
122SHOW_USED_FILES        = YES
123SHOW_FILES             = YES
124SHOW_NAMESPACES        = YES
125FILE_VERSION_FILTER    =
126LAYOUT_FILE            =
127CITE_BIB_FILES         =
128#---------------------------------------------------------------------------
129# Configuration options related to warning and progress messages
130#---------------------------------------------------------------------------
131QUIET                  = NO
132WARNINGS               = YES
133WARN_IF_UNDOCUMENTED   = YES
134WARN_IF_DOC_ERROR      = YES
135WARN_NO_PARAMDOC       = NO
136WARN_AS_ERROR          = NO
137WARN_FORMAT            = "$file:$line: $text"
138WARN_LOGFILE           =
139#---------------------------------------------------------------------------
140# Configuration options related to the input files
141#---------------------------------------------------------------------------
142INPUT                  = $1
143INPUT_ENCODING         = UTF-8
144FILE_PATTERNS          = *.c \
145                         *.cc \
146                         *.cxx \
147                         *.cpp \
148                         *.c++ \
149                         *.java \
150                         *.ii \
151                         *.ixx \
152                         *.ipp \
153                         *.i++ \
154                         *.inl \
155                         *.idl \
156                         *.ddl \
157                         *.odl \
158                         *.h \
159                         *.hh \
160                         *.hxx \
161                         *.hpp \
162                         *.h++ \
163                         *.cs \
164                         *.d \
165                         *.php \
166                         *.php4 \
167                         *.php5 \
168                         *.phtml \
169                         *.inc \
170                         *.m \
171                         *.markdown \
172                         *.md \
173                         *.mm \
174                         *.dox \
175                         *.py \
176                         *.pyw \
177                         *.f90 \
178                         *.f95 \
179                         *.f03 \
180                         *.f08 \
181                         *.f \
182                         *.for \
183                         *.tcl \
184                         *.vhd \
185                         *.vhdl \
186                         *.ucf \
187                         *.qsf \
188                         *.lib
189RECURSIVE              = YES
190EXCLUDE                =
191EXCLUDE_SYMLINKS       = NO
192EXCLUDE_PATTERNS       =
193EXCLUDE_SYMBOLS        =
194EXAMPLE_PATH           =
195EXAMPLE_PATTERNS       = *
196EXAMPLE_RECURSIVE      = NO
197IMAGE_PATH             =
198INPUT_FILTER           =
199FILTER_PATTERNS        =
200FILTER_SOURCE_FILES    = NO
201FILTER_SOURCE_PATTERNS =
202USE_MDFILE_AS_MAINPAGE =
203#---------------------------------------------------------------------------
204# Configuration options related to source browsing
205#---------------------------------------------------------------------------
206SOURCE_BROWSER         = YES
207INLINE_SOURCES         = NO
208STRIP_CODE_COMMENTS    = YES
209REFERENCED_BY_RELATION = YES
210REFERENCES_RELATION    = YES
211REFERENCES_LINK_SOURCE = YES
212SOURCE_TOOLTIPS        = YES
213USE_HTAGS              = NO
214VERBATIM_HEADERS       = YES
215CLANG_ASSISTED_PARSING = NO
216CLANG_OPTIONS          =
217#---------------------------------------------------------------------------
218# Configuration options related to the alphabetical class index
219#---------------------------------------------------------------------------
220ALPHABETICAL_INDEX     = YES
221COLS_IN_ALPHA_INDEX    = 5
222IGNORE_PREFIX          =
223#---------------------------------------------------------------------------
224# Configuration options related to the HTML output
225#---------------------------------------------------------------------------
226GENERATE_HTML          = YES
227HTML_OUTPUT            = html
228HTML_FILE_EXTENSION    = .html
229HTML_HEADER            =
230HTML_FOOTER            =
231HTML_STYLESHEET        =
232HTML_EXTRA_STYLESHEET  =
233HTML_EXTRA_FILES       =
234HTML_COLORSTYLE_HUE    = 220
235HTML_COLORSTYLE_SAT    = 100
236HTML_COLORSTYLE_GAMMA  = 80
237HTML_TIMESTAMP         = NO
238HTML_DYNAMIC_SECTIONS  = NO
239HTML_INDEX_NUM_ENTRIES = 100
240GENERATE_DOCSET        = NO
241DOCSET_FEEDNAME        = "Doxygen generated docs"
242DOCSET_BUNDLE_ID       = org.doxygen.Project
243DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
244DOCSET_PUBLISHER_NAME  = Publisher
245GENERATE_HTMLHELP      = NO
246CHM_FILE               =
247HHC_LOCATION           =
248GENERATE_CHI           = NO
249CHM_INDEX_ENCODING     =
250BINARY_TOC             = NO
251TOC_EXPAND             = NO
252GENERATE_QHP           = NO
253QCH_FILE               =
254QHP_NAMESPACE          = org.doxygen.Project
255QHP_VIRTUAL_FOLDER     = doc
256QHP_CUST_FILTER_NAME   =
257QHP_CUST_FILTER_ATTRS  =
258QHP_SECT_FILTER_ATTRS  =
259QHG_LOCATION           =
260GENERATE_ECLIPSEHELP   = NO
261ECLIPSE_DOC_ID         = org.doxygen.Project
262DISABLE_INDEX          = NO
263GENERATE_TREEVIEW      = NO
264ENUM_VALUES_PER_LINE   = 4
265TREEVIEW_WIDTH         = 250
266EXT_LINKS_IN_WINDOW    = NO
267FORMULA_FONTSIZE       = 10
268FORMULA_TRANSPARENT    = YES
269USE_MATHJAX            = NO
270MATHJAX_FORMAT         = HTML-CSS
271MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
272MATHJAX_EXTENSIONS     =
273MATHJAX_CODEFILE       =
274SEARCHENGINE           = YES
275SERVER_BASED_SEARCH    = NO
276EXTERNAL_SEARCH        = NO
277SEARCHENGINE_URL       =
278SEARCHDATA_FILE        = searchdata.xml
279EXTERNAL_SEARCH_ID     =
280EXTRA_SEARCH_MAPPINGS  =
281#---------------------------------------------------------------------------
282# Configuration options related to the LaTeX output
283#---------------------------------------------------------------------------
284GENERATE_LATEX         = NO
285LATEX_OUTPUT           = latex
286LATEX_CMD_NAME         = latex
287MAKEINDEX_CMD_NAME     = makeindex
288COMPACT_LATEX          = NO
289PAPER_TYPE             = a4
290EXTRA_PACKAGES         =
291LATEX_HEADER           =
292LATEX_FOOTER           =
293LATEX_EXTRA_STYLESHEET =
294LATEX_EXTRA_FILES      =
295PDF_HYPERLINKS         = YES
296USE_PDFLATEX           = YES
297LATEX_BATCHMODE        = NO
298LATEX_HIDE_INDICES     = NO
299LATEX_SOURCE_CODE      = NO
300LATEX_BIB_STYLE        = plain
301LATEX_TIMESTAMP        = NO
302#---------------------------------------------------------------------------
303# Configuration options related to the RTF output
304#---------------------------------------------------------------------------
305GENERATE_RTF           = NO
306RTF_OUTPUT             = rtf
307COMPACT_RTF            = NO
308RTF_HYPERLINKS         = NO
309RTF_STYLESHEET_FILE    =
310RTF_EXTENSIONS_FILE    =
311RTF_SOURCE_CODE        = NO
312#---------------------------------------------------------------------------
313# Configuration options related to the man page output
314#---------------------------------------------------------------------------
315GENERATE_MAN           = NO
316MAN_OUTPUT             = man
317MAN_EXTENSION          = .3
318MAN_SUBDIR             =
319MAN_LINKS              = NO
320#---------------------------------------------------------------------------
321# Configuration options related to the XML output
322#---------------------------------------------------------------------------
323GENERATE_XML           = NO
324XML_OUTPUT             = xml
325XML_PROGRAMLISTING     = YES
326#---------------------------------------------------------------------------
327# Configuration options related to the DOCBOOK output
328#---------------------------------------------------------------------------
329GENERATE_DOCBOOK       = NO
330DOCBOOK_OUTPUT         = docbook
331DOCBOOK_PROGRAMLISTING = NO
332#---------------------------------------------------------------------------
333# Configuration options for the AutoGen Definitions output
334#---------------------------------------------------------------------------
335GENERATE_AUTOGEN_DEF   = NO
336#---------------------------------------------------------------------------
337# Configuration options related to the Perl module output
338#---------------------------------------------------------------------------
339GENERATE_PERLMOD       = NO
340PERLMOD_LATEX          = NO
341PERLMOD_PRETTY         = YES
342PERLMOD_MAKEVAR_PREFIX =
343#---------------------------------------------------------------------------
344# Configuration options related to the preprocessor
345#---------------------------------------------------------------------------
346ENABLE_PREPROCESSING   = YES
347MACRO_EXPANSION        = NO
348EXPAND_ONLY_PREDEF     = NO
349SEARCH_INCLUDES        = YES
350INCLUDE_PATH           =
351INCLUDE_FILE_PATTERNS  =
352PREDEFINED             =
353EXPAND_AS_DEFINED      =
354SKIP_FUNCTION_MACROS   = YES
355#---------------------------------------------------------------------------
356# Configuration options related to external references
357#---------------------------------------------------------------------------
358TAGFILES               =
359GENERATE_TAGFILE       =
360ALLEXTERNALS           = NO
361EXTERNAL_GROUPS        = YES
362EXTERNAL_PAGES         = YES
363PERL_PATH              = /usr/bin/perl
364#---------------------------------------------------------------------------
365# Configuration options related to the dot tool
366#---------------------------------------------------------------------------
367CLASS_DIAGRAMS         = YES
368MSCGEN_PATH            =
369DIA_PATH               =
370HIDE_UNDOC_RELATIONS   = YES
371HAVE_DOT               = YES
372DOT_NUM_THREADS        = 0
373DOT_FONTNAME           = FreeSans
374DOT_FONTSIZE           = 10
375DOT_FONTPATH           =
376CLASS_GRAPH            = YES
377COLLABORATION_GRAPH    = YES
378GROUP_GRAPHS           = YES
379UML_LOOK               = NO
380UML_LIMIT_NUM_FIELDS   = 10
381TEMPLATE_RELATIONS     = NO
382INCLUDE_GRAPH          = YES
383INCLUDED_BY_GRAPH      = YES
384CALL_GRAPH             = YES
385CALLER_GRAPH           = NO
386GRAPHICAL_HIERARCHY    = YES
387DIRECTORY_GRAPH        = YES
388DOT_IMAGE_FORMAT       = png
389INTERACTIVE_SVG        = NO
390DOT_PATH               =
391DOTFILE_DIRS           =
392MSCFILE_DIRS           =
393DIAFILE_DIRS           =
394PLANTUML_JAR_PATH      =
395PLANTUML_CFG_FILE      =
396PLANTUML_INCLUDE_PATH  =
397DOT_GRAPH_MAX_NODES    = 50
398MAX_DOT_GRAPH_DEPTH    = 0
399DOT_TRANSPARENT        = NO
400DOT_MULTI_TARGETS      = NO
401GENERATE_LEGEND        = YES
402DOT_CLEANUP            = YES
403EOF
404
405doxygen /tmp/doxyfile
406fi
Note: See TracBrowser for help on using the repository browser.