From: Leandro Lucarella Date: Mon, 23 Jun 2003 17:28:06 +0000 (+0000) Subject: - Se agrega el archivo de configuración del Doxygen. X-Git-Tag: svn_import~86 X-Git-Url: https://git.llucax.com/mecon/yatta.git/commitdiff_plain/cfcc3268595d038b966d230e92cc50e0925a9226 - Se agrega el archivo de configuración del Doxygen. - Se agrega un diagrama UML vacío. - Se corrigen detalles. --- diff --git a/doc/Doxyfile b/doc/Doxyfile new file mode 100644 index 0000000..fad6ed7 --- /dev/null +++ b/doc/Doxyfile @@ -0,0 +1,227 @@ +# vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4: +# +--------------------------------------------------------------------+ +# | Ministerio de Economía | +# | | +# +--------------------------------------------------------------------+ +# | This file is part of . | +# | | +# | is free software; you can redistribute it and/or modify | +# | it under the terms of the GNU General Public License as published | +# | by the Free Software Foundation; either version 2 of the License, | +# | or (at your option) any later version. | +# | | +# | is distributed in the hope that it will be useful, but | +# | WITHOUT ANY WARRANTY; without even the implied warranty of | +# | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | +# | General Public License for more details. | +# | | +# | You should have received a copy of the GNU General Public License | +# | along with Hooks; if not, write to the Free Software Foundation, | +# | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | +# +--------------------------------------------------------------------+ +# | Creado: | +# | Autor: | +# +--------------------------------------------------------------------+ +# +# $Id$ +# + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = +PROJECT_NUMBER = $Rev$ +OUTPUT_DIRECTORY = api +OUTPUT_LANGUAGE = Spanish +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +INTERNAL_DOCS = YES +CASE_SENSE_NAMES = YES +SHORT_NAMES = NO +HIDE_SCOPE_NAMES = NO +VERBATIM_HEADERS = YES +SHOW_INCLUDE_FILES = YES +JAVADOC_AUTOBRIEF = YES +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = YES +INHERIT_DOCS = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 4 +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ALIASES = +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +SHOW_USED_FILES = YES +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = doxygen.warnings +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ../sistema/local_lib +FILE_PATTERNS = *.php +RECURSIVE = YES +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = YES +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = YES +TREEVIEW_WIDTH = 200 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = YES +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_SCHEMA = +XML_DTD = +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +GRAPHICAL_HIERARCHY = YES +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1024 +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO +CGI_NAME = search.cgi +CGI_URL = +DOC_URL = +DOC_ABSPATH = +BIN_ABSPATH = /usr/local/bin/ +EXT_DOC_PATHS = diff --git a/doc/uml.xmi b/doc/uml.xmi new file mode 100644 index 0000000..bb56a1a --- /dev/null +++ b/doc/uml.xmi @@ -0,0 +1,30 @@ + + + + + umbrello uml modeller http://uml.sf.net + 1.1 + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/xmi2code.tpl.php b/doc/xmi2code.tpl.php index 6542438..7f784a2 100644 --- a/doc/xmi2code.tpl.php +++ b/doc/xmi2code.tpl.php @@ -21,8 +21,8 @@ // | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | // +--------------------------------------------------------------------+ // | Creado: @@date | -// | Autor: | +// | Autor: | // +--------------------------------------------------------------------+ // // $Id$ -// \ No newline at end of file +// diff --git a/init.sh b/init.sh index 2fd7a74..31bdb1b 100755 --- a/init.sh +++ b/init.sh @@ -11,7 +11,9 @@ cat doc/xmi2code.config | awk "{ gsub(\"\", \"`date`\"); gsub(\" cat tmp > doc/xmi2code.config cat doc/xmi2code.tpl.php | awk "{ gsub(\"\", \"$SISTEMA\"); gsub(\"\", \"$AUTOR\"); print }" > tmp cat tmp > doc/xmi2code.tpl.php +cat doc/Doxyfile | awk "{ gsub(\"\", \"`date`\"); gsub(\"\", \"$SISTEMA\"); gsub(\"\", \"$AUTOR\"); print }" > tmp +cat tmp > doc/Doxyfile rm -f tmp -echo "Por favor edite los archivos doc/xmi2code.config y doc/xmi2code.tpl.php para ver que este todo bien..." -vim -o doc/xmi2code.config doc/xmi2code.tpl.php +echo "Por favor edite los archivos doc/xmi2code.config, doc/xmi2code.tpl.php y doc/Doxyfile para ver que este todo bien..." +vim -o doc/xmi2code.config doc/xmi2code.tpl.php doc/Doxyfile