# HG changeset patch
# User Louis Opter <kalessin@kalessin.fr>
# Date 1269549376 -3600
# Node ID e16869cd9773c7db6e966ec58a3df122366b0212
# Parent  a93d94340fc710054a89d1e246d853f6377359d9
Minor fixes, improve doxygen doc main page, add a CHANGELOG file

diff -r a93d94340fc7 -r e16869cd9773 CHANGELOG
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/CHANGELOG	Thu Mar 25 21:36:16 2010 +0100
@@ -0,0 +1,8 @@
+0.0.2:
+
+ * Lot of improvements in the documentation;
+ * IEndPoint refactored to allow ipv6 use (close #4) (TODO).
+
+0.0.1:
+
+ * First public version.
diff -r a93d94340fc7 -r e16869cd9773 CMakeLists.txt
--- a/CMakeLists.txt	Thu Mar 25 19:05:19 2010 +0100
+++ b/CMakeLists.txt	Thu Mar 25 21:36:16 2010 +0100
@@ -17,7 +17,7 @@
 SET(STREAMIT_API_VERSION "${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}")
 
 MESSAGE(STATUS "Cmake Version : ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}.${CMAKE_PATCH_VERSION}")
-MESSAGE(STATUS "Zia Version : ${STREAMIT_API_VERSION}")
+MESSAGE(STATUS "StreamIt API Version : ${STREAMIT_API_VERSION}")
 MESSAGE(STATUS "Build Type : ${CMAKE_BUILD_TYPE}")
 MESSAGE(STATUS "System : ${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}")
 MESSAGE(STATUS "Install Prefix : ${CMAKE_INSTALL_PREFIX}")
diff -r a93d94340fc7 -r e16869cd9773 README
--- a/README	Thu Mar 25 19:05:19 2010 +0100
+++ b/README	Thu Mar 25 21:36:16 2010 +0100
@@ -49,4 +49,5 @@
 ----
 
 How do I change the install prefix ?
--> Reconfigure the project with cmake -DCMAKE_INSTALL_PREFIX=/install/prefix/ .
+ * Use cmake-gui and change the variable CMAKE_INSTALL_PREFIX;
+ * OR reconfigure the project with cmake -DCMAKE_INSTALL_PREFIX=/install/prefix/ .
diff -r a93d94340fc7 -r e16869cd9773 include/IConfig.hpp
--- a/include/IConfig.hpp	Thu Mar 25 19:05:19 2010 +0100
+++ b/include/IConfig.hpp	Thu Mar 25 21:36:16 2010 +0100
@@ -22,7 +22,7 @@
              * @brief Get the configuration entries.
              *
              * At the moment we return a map of strings. We will see if more
-             * complex data structure will be required.
+             * complex data structure is required.
              *
              * @return the map of key/value found in configuration file.
              */
diff -r a93d94340fc7 -r e16869cd9773 include/IModule.hpp
--- a/include/IModule.hpp	Thu Mar 25 19:05:19 2010 +0100
+++ b/include/IModule.hpp	Thu Mar 25 21:36:16 2010 +0100
@@ -13,9 +13,16 @@
  *
  * @section sec_about About
  *
- * This API is maintained by the StreamIt Team: more info at www.ziastream.it.
+ * This API is maintained by the StreamIt Team: more info at
+ * <a href="http://www.ziastream.it/">www.ziastream.it</a>.
  *
  * From here you can browse the full reference on our API.
+ *
+ * @section see_also See Also
+ *
+ *   - <a href="http://code.ziastream.it/trac/api/wiki/Pr%C3%A9sentationApi">Pr&eacute;sentationApi</a>;
+ *   - <a href="http://code.ziastream.it/trac/api/wiki/R%C3%A9f%C3%A9renceRapide">R&eacute;f&eacute;renceRapide</a>;
+ *   - <a href="http://code.ziastream.it/trac/api/wiki/ThreadSafety">ThreadSafety</a>.
  */
 
 namespace   zia
diff -r a93d94340fc7 -r e16869cd9773 include/handler/IBodyHandler.hpp
--- a/include/handler/IBodyHandler.hpp	Thu Mar 25 19:05:19 2010 +0100
+++ b/include/handler/IBodyHandler.hpp	Thu Mar 25 21:36:16 2010 +0100
@@ -6,15 +6,15 @@
 # include "http/ITransaction.hpp"
 # include "handler/IHandler.hpp"
 
-namespace       zia
+namespace   zia
 {
-    namespace       api
+    namespace   api
     {
-        namespace       handler
+        namespace   handler
         {
             /**
              * @brief Interface for handlers which will interact with the
-             * client by reading or writing to its socket.
+             * client by reading or writing to its body.
              */
             class   IBodyHandler : public IHandler
             {
diff -r a93d94340fc7 -r e16869cd9773 include/handler/IHandler.hpp
--- a/include/handler/IHandler.hpp	Thu Mar 25 19:05:19 2010 +0100
+++ b/include/handler/IHandler.hpp	Thu Mar 25 21:36:16 2010 +0100
@@ -1,5 +1,5 @@
-#ifndef __ZIA_API_IHANDLER_HPP_
-# define __ZIA_API_IHANDLER_HPP_
+#ifndef __ZIA_API_IHANDLER_HPP__
+# define __ZIA_API_IHANDLER_HPP__
 
 # include "http/ITransaction.hpp"
 
@@ -10,7 +10,7 @@
         namespace   handler
         {
             /**
-             * @brief Identify a connection point in the server.
+             * @brief Identify a hook point in the server.
              */
             enum    EHook
             {
@@ -27,7 +27,7 @@
              */
             enum    ECode
             {
-                Ok,             /**< It works !*/
+                Ok,             /**< It works ! */
                 Decline,        /**< No treatment performed */
                 ClientError,    /**< Client error, module must have set the correct error code in the response headers. */
                 ServerError     /**< Server error, module must have set the correct error code in the response headers. */
@@ -53,4 +53,4 @@
     };
 };
 
-#endif	/* ! __ZIA_API_IHANDLER_HPP_ */
+#endif	/* ! __ZIA_API_IHANDLER_HPP__ */
diff -r a93d94340fc7 -r e16869cd9773 include/handler/INetworkHandler.hpp
--- a/include/handler/INetworkHandler.hpp	Thu Mar 25 19:05:19 2010 +0100
+++ b/include/handler/INetworkHandler.hpp	Thu Mar 25 21:36:16 2010 +0100
@@ -23,7 +23,8 @@
             {
             public:
                 /**
-                 * @brief Agregate functions pointers that can be "overloaded".
+                 * @brief Agregate network related functions pointers that can
+                 * be "overloaded".
                  *
                  * If a handler doesn't want to overload one of these functions
                  * it should set the pointer to @c NULL.
@@ -32,14 +33,14 @@
                 {
                     /**
                      * @brief Accept redefinition, called when we want to
-                     * accept a new connection, sock_accept return a pointer on
-                     * IEndPoint.
+                     * accept a new connection.
                      *
                      * @param [in] server Holds the accept socket.
                      *
-                     * @return Null if an error occured. Otherwise the pointer
-                     * returned MUST BE allocated using the new operator, which
-                     * the server can delete later.
+                     * @return Null if an error occured. Otherwise a pointer
+                     * ton an IEndPoint interface. The returned pointer MUST BE
+                     * allocated using the new operator, which the server can
+                     * delete later.
                      *
                      * @see network::IEndPoint
                      */
@@ -47,7 +48,7 @@
 
                     /**
                      * @brief Read redefinition, called when we want to read
-                     * something on the socket
+                     * something on the socket.
                      *
                      * @param [in] client Holds the client socket.
                      * @param [out] buffer Buffer that should be filled by the function.
@@ -86,8 +87,8 @@
                 virtual ~INetworkHandler(void) { }
 
                 /**
-                 * @brief Return the structure wich contains all function
-                 * pointers redefined.
+                 * @brief Return a structure with redefined network functions
+                 * pointers.
                  *
                  * @return A copy of the structure.
                  *
diff -r a93d94340fc7 -r e16869cd9773 include/http/IHeader.hpp
--- a/include/http/IHeader.hpp	Thu Mar 25 19:05:19 2010 +0100
+++ b/include/http/IHeader.hpp	Thu Mar 25 21:36:16 2010 +0100
@@ -11,7 +11,7 @@
         namespace   http
         {
             /**
-             * @brief provides a convenient way to interact with HTTP headers.
+             * @brief Provides a convenient way to interact with HTTP headers.
              */
             class   IHeader
             {
diff -r a93d94340fc7 -r e16869cd9773 include/http/IRequest.hpp
--- a/include/http/IRequest.hpp	Thu Mar 25 19:05:19 2010 +0100
+++ b/include/http/IRequest.hpp	Thu Mar 25 21:36:16 2010 +0100
@@ -1,5 +1,5 @@
-#ifndef __ZIA_API_REQUEST_HPP__
-# define __ZIA_API_REQUEST_HPP__
+#ifndef __ZIA_API_IREQUEST_HPP__
+# define __ZIA_API_IREQUEST_HPP__
 
 # include <string>
 
@@ -83,4 +83,4 @@
     };
 };
 
-#endif	/* ! __ZIA_API_REQUEST_HPP__ */
+#endif	/* ! __ZIA_API_IREQUEST_HPP__ */
diff -r a93d94340fc7 -r e16869cd9773 include/http/ITransaction.hpp
--- a/include/http/ITransaction.hpp	Thu Mar 25 19:05:19 2010 +0100
+++ b/include/http/ITransaction.hpp	Thu Mar 25 21:36:16 2010 +0100
@@ -1,5 +1,5 @@
-#ifndef __ZIA_API_TRANSACTION_HPP__
-# define __ZIA_API_TRANSACTION_HPP__
+#ifndef __ZIA_API_ITRANSACTION_HPP__
+# define __ZIA_API_ITRANSACTION_HPP__
 
 # include "http/IRequest.hpp"
 # include "http/IResponse.hpp"
@@ -99,4 +99,4 @@
     };
 };
 
-#endif	/* ! __ZIA_API_TRANSACTION_HPP__ */
+#endif	/* ! __ZIA_API_ITRANSACTION_HPP__ */