]> git.llucax.com Git - z.facultad/75.42/plaqui.git/commitdiff
- Se cambia la planta por defecto a planta.xml.
authorLeandro Lucarella <llucax@gmail.com>
Wed, 26 Nov 2003 15:58:15 +0000 (15:58 +0000)
committerLeandro Lucarella <llucax@gmail.com>
Wed, 26 Nov 2003 15:58:15 +0000 (15:58 +0000)
- Se actualiza y corrige documentacion.
- Se agrega un Doxyfile mas informe-frindly.

Doxyfile
Doxyfile.informe [new file with mode: 0644]
Server/include/plaqui/server/documentacion.h
Server/src/main.cpp
docs/mainpage.h

index 1ab38e0ecafb5b95483761e7ffd15c9495c388ca..fe888281019474038175bdb64539c6de1ccfc46b 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -3,7 +3,7 @@
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
-PROJECT_NAME           = PlaQui
+PROJECT_NAME           = Plaqui
 PROJECT_NUMBER         = $Rev$
 OUTPUT_DIRECTORY       = docs/api
 OUTPUT_LANGUAGE        = Spanish
@@ -124,7 +124,7 @@ TREEVIEW_WIDTH         = 250
 #---------------------------------------------------------------------------
 # configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO
 LATEX_OUTPUT           = latex
 LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
diff --git a/Doxyfile.informe b/Doxyfile.informe
new file mode 100644 (file)
index 0000000..4563339
--- /dev/null
@@ -0,0 +1,221 @@
+# Doxyfile 1.3.4
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME           = Plaqui
+PROJECT_NUMBER         = 1.0
+OUTPUT_DIRECTORY       = docs/api
+OUTPUT_LANGUAGE        = Spanish
+USE_WINDOWS_ENCODING   = NO
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = YES
+STRIP_FROM_PATH        = /home/luca/facultad/75.42/2003-2/final/Server/include/ \
+                         /home/luca/facultad/75.42/2003-2/final/Client/include/ \
+                         /home/luca/facultad/75.42/2003-2/final/Constructor/include/ \
+                         /home/luca/facultad/75.42/2003-2/final/Model/include/ \
+                         /home/luca/facultad/75.42/2003-2/final/
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = YES
+MULTILINE_CPP_IS_BRIEF = YES
+DETAILS_AT_TOP         = NO
+INHERIT_DOCS           = YES
+DISTRIBUTE_GROUP_DOC   = NO
+TAB_SIZE               = 4
+ALIASES                = 
+OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_JAVA   = NO
+SUBGROUPING            = YES
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+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
+INTERNAL_DOCS          = YES
+CASE_SENSE_NAMES       = YES
+HIDE_SCOPE_NAMES       = NO
+SHOW_INCLUDE_FILES     = YES
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = YES
+GENERATE_TODOLIST      = NO
+GENERATE_TESTLIST      = NO
+GENERATE_BUGLIST       = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS       = 
+MAX_INITIALIZER_LINES  = 30
+SHOW_USED_FILES        = YES
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = YES
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LOGFILE           = 
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT                  = Server/src \
+                         Server/include \
+                         Client/src \
+                         Client/include \
+                         Model/src \
+                         Model/include \
+                         Constructor/src \
+                         Constructor/include \
+                         docs
+FILE_PATTERNS          = *.cpp \
+                         *.h
+RECURSIVE              = YES
+EXCLUDE                = 
+EXCLUDE_SYMLINKS       = NO
+EXCLUDE_PATTERNS       = 
+EXAMPLE_PATH           = Server/tests
+EXAMPLE_PATTERNS       = *.cpp
+EXAMPLE_RECURSIVE      = YES
+IMAGE_PATH             = 
+INPUT_FILTER           = 
+FILTER_SOURCE_FILES    = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION    = NO
+VERBATIM_HEADERS       = NO
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX     = YES
+COLS_IN_ALPHA_INDEX    = 4
+IGNORE_PREFIX          = 
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML          = NO
+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         = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX         = YES
+LATEX_OUTPUT           = latex
+LATEX_CMD_NAME         = latex
+MAKEINDEX_CMD_NAME     = makeindex
+COMPACT_LATEX          = NO
+PAPER_TYPE             = a4wide
+EXTRA_PACKAGES         = 
+LATEX_HEADER           = 
+PDF_HYPERLINKS         = NO
+USE_PDFLATEX           = YES
+LATEX_BATCHMODE        = YES
+LATEX_HIDE_INDICES     = YES
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF           = NO
+RTF_OUTPUT             = rtf
+COMPACT_RTF            = NO
+RTF_HYPERLINKS         = NO
+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_OUTPUT             = xml
+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           = /usr/include \
+                         /usr/include/c++/3.2 \
+                         /usr/include/c++/3.3 \
+                         /usr/include/gtkmm-2.0
+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            = NO
+COLLABORATION_GRAPH    = YES
+UML_LOOK               = NO
+TEMPLATE_RELATIONS     = YES
+INCLUDE_GRAPH          = NO
+INCLUDED_BY_GRAPH      = NO
+CALL_GRAPH             = NO
+GRAPHICAL_HIERARCHY    = YES
+DOT_IMAGE_FORMAT       = png
+DOT_PATH               = 
+DOTFILE_DIRS           = 
+MAX_DOT_GRAPH_WIDTH    = 1024
+MAX_DOT_GRAPH_HEIGHT   = 1024
+MAX_DOT_GRAPH_DEPTH    = 0
+GENERATE_LEGEND        = YES
+DOT_CLEANUP            = YES
+#---------------------------------------------------------------------------
+# Configuration::addtions related to the search engine   
+#---------------------------------------------------------------------------
+SEARCHENGINE           = NO
index 2d022e478a581cd365b46f45db16b7f262faf032..f2a47090c9285f58e8600f99586b153cc3786ab9 100644 (file)
                                    etc).</td>
                        </tr>
                        <tr>
-                               <td><tt>start/[plant]/[host]/[port]</tt></td>
-                               <td>Comienza la transmisión de la planta [plant] al [host]
+                               <td><tt>start/[pl]/[host]/[port]</tt></td>
+                               <td>Comienza la transmisión de la planta [pl] al [host]
                                    en el puerto [port].</td>
                                <td>Nada.</td>
                        </tr>
                                    corriendo o no, uptime, cantidad de elementos,etc).</td>
                        </tr>
                        <tr>
-                               <td><tt>get/[planta]</tt></td>
-                               <td>Obtiene la planta de nombre [planta].</td>
+                               <td><tt>get/[pl]</tt></td>
+                               <td>Obtiene la planta de nombre [pl].</td>
                                <td>El mismo archivo que se crea en el Constructor.</td>
                        </tr>
                        <tr>
-                               <td><tt>set/[planta]/[elem]/[prop]/[val]</tt></td>
-                               <td>Cambia la propiedad [prop] del elemento [elem], asignándole
-                                   el valor [val] a planta de nombre [planta].</td>
+                               <td><tt>set/[pl]/[el]/[pr]/[val]</tt></td>
+                               <td>Cambia la propiedad [pr] del elemento [el], asignándole
+                                   el valor [val] a planta de nombre [pl].</td>
                                <td>Nada.</td>
                        </tr>
                        <tr>
-                               <td><tt>set_frequency/[planta]/[vecesxseg]</tt></td>
+                               <td><tt>set_frequency/[pl]/[hz]</tt></td>
                                <td>Cambia la frecuencia de refresco de la simulación de la
-                                   planta de nombre [planta] a [vecesxseg] veces por
-                                   segundo. Si [vecesxseg] es cero ("0"), se usa la frecuencia
-                                   de refresco por omisión del servidor.</td>
+                                   planta de nombre [pl] a [hz] veces por segundo. Si [hz]
+                                   es cero ("0"), se usa la frecuencia de refresco por
+                                   omisión del servidor.</td>
                                <td>Nada.</td>
                        </tr>
                        <tr>
-                               <td><tt>start/[planta]</tt></td>
+                               <td><tt>start/[pl]</tt></td>
                                <td>Reanuda (o comienza) la simulación de la planta de nombre
-                                   [planta].</td>
+                                   [pl].</td>
                                <td>Nada.</td>
                        </tr>
                        <tr>
-                               <td><tt>stop/[planta]</tt></td>
+                               <td><tt>stop/[pl]</tt></td>
                                <td>Pausa la simulación de la planta de nombre
-                                   [planta].</td>
+                                   [pl].</td>
                                <td>Nada.</td>
                        </tr>
                        <tr>
-                               <td><tt>remove/[planta]</tt></td>
+                               <td><tt>remove/[pl]</tt></td>
                                <td>Finaliza la simulación de la planta de nombre
-                                   [planta] eliminandola del servidor.</td>
+                                   [pl] eliminandola del servidor.</td>
                                <td>Nada.</td>
                        </tr>
                </table>
        (por ejemplo, generado por el Constructor).
 
        Invocación del servidor:
-       \verbatim ./plaqui-server [planta.xml] [puerto] \endverbatim
+       \verbatim ./plaqui-server [archivo] [puerto] \endverbatim
 
-       Ambos argumentos son opcionales. El primero, <tt>[planta.xml]</tt>, es la
+       Ambos argumentos son opcionales. El primero, <tt>[archivo]</tt>, es la
        ubicación del archivo con la descripción de la planta a simular (por omisión
-       <tt>prueba.xml</tt>). El segundo, <tt>[puerto]</tt>, es el puerto en el cual
+       <tt>planta.xml</tt>). El segundo, <tt>[puerto]</tt>, es el puerto en el cual
        se van a atender las peticiones al servidor (por omisión 7522).
 
 */
index 487fb6c1fa9708f94b0eaa7070239ba82d1c8394..89409213e63ae028c90d025b79bd33f402a53e62 100644 (file)
@@ -74,7 +74,7 @@ int main(int argc, char* argv[]) {
        cout << "\t" << argv[0] << " [planta] [puerto]" << endl;
 
        // Acepta argumentos.
-       string filename = "prueba.xml";
+       string filename = "planta.xml";
        Connection::Port port = 7522;
        if (argc > 1) {
                // Obtengo nombre del archivo de la planta.
index 6939d24776ff7a514cf486434aba65823cda4fd0..4a4b903cdd021a9892c5a15cce18f3704855d3e5 100644 (file)
@@ -1,4 +1,4 @@
-/** \mainpage PlaQui
+/** \mainpage Plaqui
 
 \section introduccion Introducción