Environment redesign and test/examples review. English API revisions

[anna.git] / include / anna / comm / LiteTransport.hpp

diff --git a/include/anna/comm/LiteTransport.hpp b/include/anna/comm/LiteTransport.hpp
index 8403a87..ce9365d 100644 (file)
--- a/include/anna/comm/LiteTransport.hpp
+++ b/include/anna/comm/LiteTransport.hpp
@@ -46,38 +46,32 @@ namespace anna {
 namespace comm {
 
 /**
-   Este protocolo esta orientado a intercambiar mensajes en una red interna, por lo que supone
-   que no van a existir errores en los mensajes recibidos y que los mensajes son suficientemente cortos
-   como poder representar su longitud en dos nicos bytes.
+  Protocol oriented to internal network messages interchange, supposing no errors in transmision and short-sized
+  messages which allows length representation in only two bytes. No synchronization mechanisms are provided, then
+  a single error could cause problems in our process.
 
-   Los supuestos bajo los que se dise este protocolo facilitan el desarrollo de clases que ofrecen un
-   gran rendimiento, pero imposibilitan el desarrollo del sistema de re-sincronizacin en caso de que alguno
-   de los mensajes no cumpla los supuestos. Es decir, si nos llega un mensaje errneo nuestro proceso no sera
-   capaz de volver a sincronizarse nunca mas.
+  @warning Encode mode does not provide enough information to allow re-synchronization in case of error
 
-   \warning Hay que tener en cuenta que el m�odo de codificacin no ofrece informacin
-   suficiente para poder re-sincronizar los procesos en caso de error.
-
-   \see Transport.
+  \see Transport.
 */
 class LiteTransport : public comm::Transport {
 public:
   static const int headerSize = sizeof(short int);  /**< Tamao de la cabezera del mensaje */
 
   /**
-     Destructor
+    Destructor.
   */
   ~LiteTransport();
 
   /**
-     Devuelve el literal que indentifica de esta clase.
-     \return el literal que indentifica de esta clase.
+    Returns the class name literal. 
+    @return class name literal. 
   */
   static const char* className() throw() { return "anna::comm::LiteTransport"; }
 
   /**
-     Devuelve el gestor de capas de transporte asociado a esta clase.
-     \return El gestor de capas de transporte asociado a esta clase.
+    Returns the transport factory associated to this class
+    @return transport factory associated to this class
   */
   static TransportFactory& getFactory() throw() { return st_transportFactory; }