From cdce7c32e0b3dd06973cd4cbeb5e4f6eb38391ab Mon Sep 17 00:00:00 2001
From: Leandro Lucarella <llucax@gmail.com>
Date: Mon, 1 Dec 2003 23:46:17 +0000
Subject: [PATCH] Se documentan codigos de error de la respuesta XML.

---
 Server/include/plaqui/server/documentacion.h | 17 ++++++------
 Server/include/plaqui/server/response.h      | 28 ++++++++++----------
 2 files changed, 23 insertions(+), 22 deletions(-)

diff --git a/Server/include/plaqui/server/documentacion.h b/Server/include/plaqui/server/documentacion.h
index 2b268ec..87ae0db 100644
--- a/Server/include/plaqui/server/documentacion.h
+++ b/Server/include/plaqui/server/documentacion.h
@@ -205,14 +205,15 @@
 	Las respuestas del servidor, como se dijo anteriormente, son respuestas HTTP, cuyo
 	cuerpo es un archivo XML. Este archivo se compone de un <em>tag</em> XML
 	<tt>plaqui-response</tt> y tiene como atributos obligatorios <tt>code</tt> (indica
-	el código de respuesta, para saber si se realizó bien el comando) y <tt>version</tt>
-	(indica la versión del formato del archivo XML, para preveer la posibilidad de que
-	 cambie en futuras versiones). También tiene un atributo opcional <tt>description</tt>
-	que permite agregar una descripción sobre la respuesta, útil para observar respuestas
-	con un navegador u otro cliente no específico. El <em>tag</em>plaqui-response</em>
-	puede tener un contenido, en caso de que la respuesta necesite enviar información al
-	cliente (como al obtener una planta o una lista). El contenido es a su vez XML y en
-	el caso de la obtención de una planta tiene el mismo formato que el utilizado por el
+	el \ref PlaQui::Server::Response::Code "código de respuesta", para saber si se
+	realizó bien el comando) y <tt>version</tt> (indica la versión del formato del
+	archivo XML, para preveer la posibilidad de que cambie en futuras versiones).
+	También tiene un atributo opcional <tt>description</tt> que permite agregar una
+	descripción sobre la respuesta, útil para observar respuestas con un navegador u
+	otro cliente no específico. El <em>tag</em>plaqui-response</em> puede tener un
+	contenido, en caso de que la respuesta necesite enviar información al cliente
+	(como al obtener una planta o una lista). El contenido es a su vez XML y en el
+	caso de la obtención de una planta tiene el mismo formato que el utilizado por el
 	Constructor.
 
 \section page_server_uso Modo de uso.
diff --git a/Server/include/plaqui/server/response.h b/Server/include/plaqui/server/response.h
index 16e52de..d912002 100644
--- a/Server/include/plaqui/server/response.h
+++ b/Server/include/plaqui/server/response.h
@@ -46,20 +46,20 @@ namespace Server {
 
 			/// Código de respuesta.
 			typedef enum {
-				OK,
-				UNKNOWN_ERROR,
-				INVALID_TARGET,
-				INVALID_COMMAND,
-				ARGUMENT_MISSING,
-				ALLREADY_EXISTS,
-				CONNECTION_NOT_FOUND,
-				TRANSMISSION_NOT_FOUND,
-				PLANT_NOT_FOUND,
-				ELEMENT_NOT_FOUND,
-				ELEMENT_INPUT_NOT_FOUND,
-				ERROR_STARTING_TRANSMISSION,
-				ERROR_GETING_PLANT_XML,
-				ERROR_CHANGING_ELEMENT_INPUT
+				OK,                ///< Comando ejecutado con éxito.
+				UNKNOWN_ERROR,      ///< Error desconocido.
+				INVALID_TARGET,      ///< Destino del comando inválido.
+				INVALID_COMMAND,      ///< Comando inválido para el destino.
+				ARGUMENT_MISSING,      ///< Faltan argumentos para el comando.
+				ALLREADY_EXISTS,        ///< Ya existe la transmisión.
+				CONNECTION_NOT_FOUND,    ///< Conexión no encontrada.
+				TRANSMISSION_NOT_FOUND,   ///< Transmisión no encontrada.
+				PLANT_NOT_FOUND,           ///< Planta no encontrada.
+				ELEMENT_NOT_FOUND,          ///< Elemento no encontrado.
+				ELEMENT_INPUT_NOT_FOUND,     ///< No existe la entrada para el elemento.
+				ERROR_STARTING_TRANSMISSION, ///< No se pudo empezar la transmisión.
+				ERROR_GETING_PLANT_XML,      ///< No se pudo obtener el XML de la planta.
+				ERROR_CHANGING_ELEMENT_INPUT ///< No se pudo cambiar la entrada del elemento.
 			} Code;
 
 		private:
-- 
2.43.0