- Se completa un poco la doc del cliente.

- Se actualizan las referencias de la mainpage.
- Se actualiza la TODO list.

diff --git a/Client/include/documentation.h b/Client/include/documentation.h
index c14a049271d518fc9521d011556b73beda3e25cf..68bc1986966515413dff6295f9de3affa0a9b7e0 100644 (file)
--- a/Client/include/documentation.h
+++ b/Client/include/documentation.h
@@ -6,18 +6,26 @@
        una simulación.
 
        Esta aplicación es básicamente un <em>front-end</em> para el
        una simulación.
 
        Esta aplicación es básicamente un <em>front-end</em> para el

-       \ref PlaQui::Server::ControlClient "controlclient", una clase del 
-       servidor que es la encargada de realizar las conexiones TCP/IP y de
-       proveer una interfaz simple al cliente gráfico.
+       \ref PlaQui::Server::ControlClient "cliente de control", una clase del 
+       servidor que es la encargada de realizar las conexiones TCP/IP en un thread
+       (para no bloquear la interfaz gráfica) y de proveer una interfaz simple al
+       cliente gráfico. Para enviar un comando al servidor simplemente se
+       \ref PlaQui::Server::ControlClient::send "envía" un PlaQui::Server::Command.
+       Las respuestas se reciben a través de señales. Esto resulta muy familiar ya
+       trabaja de la misma forma que los eventos de la interfaz gráfica.

 
        El cliente permite conectarse y desconectarse de un servidor, pausar
 
        El cliente permite conectarse y desconectarse de un servidor, pausar

-       o reanudar una simulación; ver el estado de los items entre otra cosas.
+       o reanudar una simulación; ver el estado de los ítem entre otra cosas.

 
        También permite de forma muy intuitiva controlar la lógica de control, dibujando
        los cables en <em>alto</em> en color rojo y los cables en <em>bajo</em> en color
 
        También permite de forma muy intuitiva controlar la lógica de control, dibujando
        los cables en <em>alto</em> en color rojo y los cables en <em>bajo</em> en color

-       azul. De esta manera usuario tendra una perspectiva de toda la planta conociendo 
+       azul. De esta manera usuario tenderá una perspectiva de toda la planta conociendo 

        el estado de la misma en cada instante, pudiendo modificar la velocidad de 
        el estado de la misma en cada instante, pudiendo modificar la velocidad de 

-       actualizacion como crea mas conveniente.
+       actualización como crea mas conveniente.

 
 

+       Todo el trabajo este realizado por la clase Principal. Los elementos dibujados
+       heredan todos de ViewItem, implementando sus características particulares en las
+       subclases.

 
 */
 
 */

+

diff --git a/TODO b/TODO
index 10e1fba6276b59be7750b8ef25c3c16773328e74..2c2b36bf1035de3194e64b5960867df50134b69a 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,13 +1,8 @@
 $Id$
 
 $Id$
 

-1) Completar codigo.
-  a) (gazer) Completar documentacion en linea (todo lo que va a ir al manual de
-     desarrollo).                                                      
-
-2) Terminar manuales.
-  a) (sagar) Actualizar manual de cliente (faltan screenshots nomas).
-  b) (luca) Limpiar un poco más el manual de desarrollo/administrador imprimible.
-  c) Hacer manual del proyecto.
+1) Terminar manuales.
+  a) (luca) Limpiar un poco más el manual de desarrollo/administrador imprimible.
+  b) Hacer manual del proyecto.

     i)   Poner falencias:
          - Lo de los sockets bloqueantes y conexion suicida.
          - El constructor no pregunta si hay que grabar al salir.
     i)   Poner falencias:
          - Lo de los sockets bloqueantes y conexion suicida.
          - El constructor no pregunta si hay que grabar al salir.


@@ -19,13 +14,13 @@ $Id$
     v)   Conclusiones (perfeccionamos C++, aprendimos GTKmm, autoconf,
          automake, etc).
 
     v)   Conclusiones (perfeccionamos C++, aprendimos GTKmm, autoconf,
          automake, etc).
 

-3) Imprimir.
+2) Imprimir.

   a) Manuales.
   b) (luca) Codigo fuente.
   c) Programas de prueba (calculo que lo que esta en tests/).
   d) Archivos de prueba.
 
   a) Manuales.
   b) (luca) Codigo fuente.
   c) Programas de prueba (calculo que lo que esta en tests/).
   d) Archivos de prueba.
 

-4) Armar CD.
+3) Armar CD.

   a) Generar documentacion en linea (ejecutar doxygen).
   b) Meterle los manuales en PDF y en lo posible en HTML tambien.
   c) Poner tarball con la ultima version de PlaQui.
   a) Generar documentacion en linea (ejecutar doxygen).
   b) Meterle los manuales en PDF y en lo posible en HTML tambien.
   c) Poner tarball con la ultima version de PlaQui.

diff --git a/docs/mainpage.h b/docs/mainpage.h
index b6cb09ee2264beee521f10a68609eff70ddbcd84..0bf743df4fc39b166e9fcf34b261be75d04e8506 100644 (file)
--- a/docs/mainpage.h
+++ b/docs/mainpage.h
@@ -62,7 +62,7 @@
        - \ref page_server "Servidor": es la infrastructura de red. Comprende tanto
          el servidor como el cliente en cuando al manejo de la red (es una
          biblioteca y un  programa).
        - \ref page_server "Servidor": es la infrastructura de red. Comprende tanto
          el servidor como el cliente en cuando al manejo de la red (es una
          biblioteca y un  programa).

-       - Cliente: es el cliente gráfico que permite ver la simulación (es un
+       - \ref Client "Cliente": es el cliente gráfico que permite ver la simulación (es un

          programa).
        - \ref page_constructor "Constructor": es el programa para diseñar la planta química
          que será simulada por el modelo en el servidor (es un programa).
          programa).
        - \ref page_constructor "Constructor": es el programa para diseñar la planta química
          que será simulada por el modelo en el servidor (es un programa).


@@ -148,7 +148,7 @@
                se detecta un error.
 
                Otro tipo de información del estado del servidor puede ser obtenida desde
                se detecta un error.
 
                Otro tipo de información del estado del servidor puede ser obtenida desde

-               el cliente a través del comando <tt>/server/info</tt>.
+               el \ref Client "cliente" a través del comando <tt>/server/info</tt>.

 
                \note Los errores se imprimen en la salida de error, no en la salida
                      estándar.
 
                \note Los errores se imprimen en la salida de error, no en la salida
                      estándar.


@@ -160,7 +160,7 @@
                - Enviando una señal de salida (<tt>SIGQUIT</tt>) o de terminación
                  (<tt>SIGTERM</tt>), por ejemplo, a través del comando
                  <tt>kill(1)</tt>.
                - Enviando una señal de salida (<tt>SIGQUIT</tt>) o de terminación
                  (<tt>SIGTERM</tt>), por ejemplo, a través del comando
                  <tt>kill(1)</tt>.

-               - Enviando un comando <tt>/server/stop</tt> desde un cliente.
+               - Enviando un comando <tt>/server/stop</tt> desde un \ref Client "cliente".

 
                Cualquiera de estos métodos es válido y finaliza el servidor de forma
                correcta.
 
                Cualquiera de estos métodos es válido y finaliza el servidor de forma
                correcta.