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