source: installer/ogGenerateDoc.sh @ fcac41e

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 fcac41e was 1531e57, checked in by ramon <ramongomez@…>, 8 years ago

Versión 1.0.6b #754: Doxygen solo genera HTML e incluye el logo del proyecto; actualizar lista de tickets cerrados.

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