Fix documentation typos

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@197 270642c3-0616-0410-b53a-bc976706d245

diff --git a/Mainpage.dox b/Mainpage.dox
index 5d0dbeb..b472354 100644 (file)
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -66,7 +66,7 @@
     \li Doxygen (http://www.doxygen.org)
     \li The \c dia diagram editor (http://www.gnome.org/projects/dia/)
     \li HTML \c tidy (http://tidy.sourceforge.net/)
-    \li \The \c xsltproc XSLT processor (http://xmlsoft.org/XSLT/xsltproc2.html)
+    \li The \c xsltproc XSLT processor (http://xmlsoft.org/XSLT/xsltproc2.html)
 
 
     The library is only tested with gcc-3.4 and 4.0 on Linux. On other

diff --git a/Socket/ClientSocketHandle.hh b/Socket/ClientSocketHandle.hh
index 64e7372..cbe6113 100644 (file)
--- a/Socket/ClientSocketHandle.hh
+++ b/Socket/ClientSocketHandle.hh
@@ -303,7 +303,7 @@ namespace senf {
            For addressable protocols (AddressingPolicy is not NoAddressingPolicy), bind() will set
            the local address of the socket.
 
-           \parm[in] addr Local socket address to asign
+           \param[in] addr Local socket address to asign
 
            \throws senf::SystemException
         */

diff --git a/Socket/CommunicationPolicy.hh b/Socket/CommunicationPolicy.hh
index 097a8bf..71fe0bd 100644 (file)
--- a/Socket/CommunicationPolicy.hh
+++ b/Socket/CommunicationPolicy.hh
@@ -53,11 +53,12 @@ namespace senf {
     {
         static void listen(FileHandle handle, unsigned backlog);
                                         ///< Enable establishing new connections on the socket
-                                        /** \param[in] handle socket handle to enable reception on
-                                           \param[in] backlog size of backlog queue
-                                           
-                                           \fixme listen probably makes no sense without accpept,
-                                               so listen() should debend on AddressingPolicy too. */
+                                        /**< \param[in] handle socket handle to enable reception on
+                                            \param[in] backlog size of backlog queue
+                                            
+                                            \fixme listen probably makes no sense without accpept,
+                                                so listen() should debend on AddressingPolicy
+                                                too. */
         template <class Policy>
         static int accept(ServerSocketHandle<Policy> handle, 
                           typename ServerSocketHandle<Policy>::Address & address,

diff --git a/Socket/ServerSocketHandle.hh b/Socket/ServerSocketHandle.hh
index 9875737..7c84d93 100644 (file)
--- a/Socket/ServerSocketHandle.hh
+++ b/Socket/ServerSocketHandle.hh
@@ -121,7 +121,7 @@ namespace senf {
            For addressable protocols (AddressingPolicy is not NoAddressingPolicy), bind() will set
            the local address of the socket.
 
-           \parm[in] addr Local socket address to asign
+           \param[in] addr Local socket address to asign
 
            \throws senf::SystemException
         */
@@ -182,7 +182,7 @@ namespace senf {
                                         ///< Accept new connection
                                         /**< This variant will additionally return the remote
                                           address of the client
-                                          \params[out] client address
+                                          \param[out] client address
                                           \returns handle of new client connection
                                           \see \ref accept() */
         

diff --git a/Socket/SocketPolicy.hh b/Socket/SocketPolicy.hh
index db8cee5..6fd63c9 100644 (file)
--- a/Socket/SocketPolicy.hh
+++ b/Socket/SocketPolicy.hh
@@ -439,7 +439,7 @@ namespace senf {
     
     /** \brief Check single policy axis
        
-       This template is an example of the \i Policy \c Is family of
+       This template is an example of the \e Policy \c Is family of
        tempalte metafunctions. It will check, wether \c Trait is a
        valid compatible Policy class of \c SocketPolicy. \c Trait
        must be derived from AddressingPolicyBase (respectively \i
@@ -453,11 +453,11 @@ namespace senf {
 
     /** \brief Enable template overload depending on policy value
 
-       This template is an exmaple of the \c If \i Policy \c Is
+       This template is an exmaple of the \c If \e Policy \c Is
        family of templates. It is used like <a class="ext"
        href="http://www.boost.org/libs/utility/enable_if.html">Boost.enable_if</a>
        to enable a templated overload only, if the AddressingPolicy
-       of \i Policy is compatible with \c Trait (that is the
+       of \e Policy is compatible with \c Trait (that is the
        AddressingPolicy of \c Policy is derived from \c Trait).
 
        \see policy_group
@@ -508,7 +508,7 @@ namespace senf {
 
        A SocketPolicy can be complete or incomplete. An incomplete
        SocketPolicy will have at least one axis set to \c Undefined
-       \i Policy (or a generic derived class which is used to group
+       \e Policy (or a generic derived class which is used to group
        some other policies but does not (completely) define the
        policy behavior). A complete SocketPolicy will have a
        concrete definition of the desired behavior for each policy
@@ -541,7 +541,7 @@ namespace senf {
        SocketPolicy instantiation. It takes any number (that is up to
        6) of Policy classes as arguments in any Order. It will create
        a SocketPolicy from these policy classes. Any axis not
-       specified will be left as \c Unspecified \i Policy. 
+       specified will be left as \c Unspecified \e Policy. 
 
        \see policy_group
      */