From: Leandro Lucarella Date: Wed, 19 Nov 2003 23:46:58 +0000 (+0000) Subject: - Se arregla un poco la documentacion y se pasa el Doxyfile a nivel general (no X-Git-Tag: svn_import~238 X-Git-Url: https://git.llucax.com/z.facultad/75.42/plaqui.git/commitdiff_plain/20f9c9932f7c6e0ba6d50636a6d73420da79606b?ds=sidebyside - Se arregla un poco la documentacion y se pasa el Doxyfile a nivel general (no se si sera lo mejor). --- diff --git a/Server/Doxyfile b/Doxyfile similarity index 87% rename from Server/Doxyfile rename to Doxyfile index d0fcea6..9df9e13 100644 --- a/Server/Doxyfile +++ b/Doxyfile @@ -3,9 +3,9 @@ #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -PROJECT_NAME = plaqui-server -PROJECT_NUMBER = 0.2 -OUTPUT_DIRECTORY = doc +PROJECT_NAME = PlaQui +PROJECT_NUMBER = $Rev$ +OUTPUT_DIRECTORY = docs/api OUTPUT_LANGUAGE = Spanish USE_WINDOWS_ENCODING = NO BRIEF_MEMBER_DESC = YES @@ -14,7 +14,13 @@ 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/Server/ + /home/luca/facultad/75.42/2003-2/final/Server/src/ \ + /home/luca/facultad/75.42/2003-2/final/Client/include/ \ + /home/luca/facultad/75.42/2003-2/final/Client/src/ \ + /home/luca/facultad/75.42/2003-2/final/Constructor/include/ \ + /home/luca/facultad/75.42/2003-2/final/Constructor/src/ \ + /home/luca/facultad/75.42/2003-2/final/Model/include/ \ + /home/luca/facultad/75.42/2003-2/final/Model/src/ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES MULTILINE_CPP_IS_BRIEF = YES @@ -62,15 +68,21 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = src \ - include +INPUT = Server/src \ + Server/include \ + Client/src \ + Client/include \ + Model/src \ + Model/include \ + Constructor/src \ + Constructor/include FILE_PATTERNS = *.cpp \ *.h RECURSIVE = YES EXCLUDE = EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = -EXAMPLE_PATH = tests +EXAMPLE_PATH = Server/tests EXAMPLE_PATTERNS = *.cpp EXAMPLE_RECURSIVE = YES IMAGE_PATH = @@ -89,7 +101,7 @@ VERBATIM_HEADERS = YES # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = YES -COLS_IN_ALPHA_INDEX = 3 +COLS_IN_ALPHA_INDEX = 4 IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output @@ -114,7 +126,7 @@ TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -GENERATE_LATEX = NO +GENERATE_LATEX = YES LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex @@ -122,8 +134,8 @@ COMPACT_LATEX = NO PAPER_TYPE = a4wide EXTRA_PACKAGES = LATEX_HEADER = -PDF_HYPERLINKS = NO -USE_PDFLATEX = NO +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- @@ -177,7 +189,7 @@ SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::addtions related to external references #--------------------------------------------------------------------------- -TAGFILES = /usr/share/doc/libgtkmm2.0-dev/reference/gtkmm_doxygen_tags +TAGFILES = GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = YES diff --git a/Server/include/plaqui/server/connection.h b/Server/include/plaqui/server/connection.h index e20f22e..1eab7fa 100644 --- a/Server/include/plaqui/server/connection.h +++ b/Server/include/plaqui/server/connection.h @@ -73,7 +73,7 @@ namespace Server { /** * Constructor. * - * \param socket Descriptor de socket a usar en la conexión. + * \param sd Descriptor de socket a usar en la conexión. */ Connection(const sockbuf::sockdesc& sd); @@ -81,6 +81,8 @@ namespace Server { * Constructor. * * \param type Tipo de socket a usar. + * \param host Host a donde conectarse. + * \param port Puerto al cual conectarse. */ Connection(const sockbuf::type& type, const std::string& host, const Port& port); @@ -89,7 +91,7 @@ namespace Server { * Constructor. * * \param host Host a donde conectarse. - * \param port Puerto a donde conectarse. + * \param port Puerto al cual conectarse. */ Connection(const std::string& host, const Port& port); @@ -106,11 +108,15 @@ namespace Server { /** * Obtiene el nombre del host local de la conexión. + * \todo TODO - Debería devolver una copia? Porque podría morir la + * conexion y nosotros seguir usando la variable destruida. */ const std::string& get_host(void) const; /** * Obtiene el puerto local de la conexión. + * \todo TODO - Debería devolver una copia? Porque podría morir la + * conexion y nosotros seguir usando la variable destruida. */ const Port& get_port(void) const; diff --git a/Server/include/plaqui/server/controlclient.h b/Server/include/plaqui/server/controlclient.h index 507d222..c2e4a28 100644 --- a/Server/include/plaqui/server/controlclient.h +++ b/Server/include/plaqui/server/controlclient.h @@ -88,9 +88,9 @@ namespace Server { /** * Constructor. * - * \param host Host al cual conectarse para enviar comandos de + * \param _host Host al cual conectarse para enviar comandos de * control. - * \param port Puerto al cual conectarse. + * \param _port Puerto al cual conectarse. */ ControlClient(const std::string& _host = "localhost", const Connection::Port& _port = 7522) throw(sockerr); diff --git a/Server/include/plaqui/server/plant.h b/Server/include/plaqui/server/plant.h index 89ee76f..72959ca 100644 --- a/Server/include/plaqui/server/plant.h +++ b/Server/include/plaqui/server/plant.h @@ -88,7 +88,6 @@ namespace Server { /** * Constructor desde un archivo. * - * \param name Nombre de la planta. * \param filename Nombre del archivo de donde obtener la planta. */ Plant(const std::string& filename); diff --git a/Server/include/plaqui/server/server.h b/Server/include/plaqui/server/server.h index 9953fd9..ae83251 100644 --- a/Server/include/plaqui/server/server.h +++ b/Server/include/plaqui/server/server.h @@ -137,7 +137,8 @@ namespace Server { /** * Constructor. * - * \param port Puerto en el cual escuchar. + * \param filename Nombre del archivo con la planta a cargar. + * \param port Puerto en el cual escuchar. */ Server(const std::string& plant_filename, const Connection::Port& port = 7522) throw(sockerr); @@ -151,17 +152,10 @@ namespace Server { /** * Se encarga de borrar una planta de la lista cuando finaliza. * - * \param connection Conexión a eliminar. + * \param plant Nombre de la planta a elminar. */ void on_plant_finished(const char* plant); - /** - * Envia el estado de una planta cuando esta se actualiza. - * - * \param plant Planta actualizada. - */ - void on_plant_updated(const Plant* const); - }; } diff --git a/Server/include/plaqui/server/string.h b/Server/include/plaqui/server/string.h index f29e1b4..96e2bb8 100644 --- a/Server/include/plaqui/server/string.h +++ b/Server/include/plaqui/server/string.h @@ -40,7 +40,7 @@ namespace Server { * Convierte de un tipo a otro (de p1 a p2) a través de un stringstream. * * \param p1 Parámetro origen. - * \param p1 Parámetro destino, al que se quiere convertir. + * \param p2 Parámetro destino, al que se quiere convertir. * * \return Referencia a p2. */ @@ -90,7 +90,7 @@ namespace Server { /** * Elmina caracteres al inicio y fin de un string. * - * \param c Lista de caracteres a eliminar. + * \param clist Lista de caracteres a eliminar. */ String& trim(const String& clist = SPACE_CHARS); diff --git a/Server/include/plaqui/server/transmitter.h b/Server/include/plaqui/server/transmitter.h index 98957fe..3e99f41 100644 --- a/Server/include/plaqui/server/transmitter.h +++ b/Server/include/plaqui/server/transmitter.h @@ -61,8 +61,8 @@ namespace Server { * Los parámetros son modificados por los valores reales que toma * una vez conectado. * - * \param host Host al cual transmitir. - * \param port Puerto al cual transmitir. + * \param _host Host al cual transmitir. + * \param _port Puerto al cual transmitir. */ Transmitter(const std::string& _host, const Connection::Port& _port) throw(sockerr);