Add more #ifndef DOXYGEN comments to hide boost::enable_if type constructs

[senf.git] / Socket / GenericAddressingPolicy.hh

diff --git a/Socket/GenericAddressingPolicy.hh b/Socket/GenericAddressingPolicy.hh
index 7eeed12..b8bcfc3 100644 (file)
--- a/Socket/GenericAddressingPolicy.hh
+++ b/Socket/GenericAddressingPolicy.hh
@@ -41,7 +41,7 @@ namespace senf {
     /// \addtogroup policy_impl_group
     /// @{
 
-    /** \brief Non-template implemenatation class of GenericAddressingPolicy template
+    /** \brief Non-template implementation class of GenericAddressingPolicy template
 
         \internal
      */
@@ -74,37 +74,47 @@ namespace senf {
         members. sockaddr_p could always return a const * whereas open_sockaddr_p should return a
         non-const pointer. The close operation would then explicitly signal, that the new value
         should be incorporated into the class. With our current implementation, the close member
-        would be a no-op, however this ould free us from using the sockaddr values as a direct
-        sotrage representation of the address.
+        would be a no-op, however this should free us from using the sockaddr values as a direct
+        storage representation of the address.
      */
     template <class Address>
     struct GenericAddressingPolicy
         : private GenericAddressingPolicy_Base
     {
+#       ifndef DOXYGEN
         template <class Policy>
         static void peer(SocketHandle<Policy> handle, Address & addr,
                          typename IfCommunicationPolicyIs<Policy,ConnectedCommunicationPolicy>::type * = 0);
+#       else
+        template <class Policy>
+        static void peer(SocketHandle<Policy> handle, Address & addr);
                                         ///< Return address of remote peer on connected sockets
                                         /**< This member is only available if the socket handles
                                              communication policy is ConnectedCommunicationPolicy.
 
                                              \param[in] handle socket handle to get peer address of
                                              \param[out] addr address of remote peer */
+#       endif
         static void local(FileHandle handle, Address & addr);
                                         ///< Return local of socket
                                         /**< \param[in] handle socket handle to check
                                              \param[out] addr local socket address */
 
+#       ifndef DOXYGEN
         template <class Policy>
         static void connect(SocketHandle<Policy> handle, Address const & addr,
                             typename IfCommunicationPolicyIs<Policy,ConnectedCommunicationPolicy>::type * = 0);
+#       else
+        template <class Policy>
+        static void connect(SocketHandle<Policy> handle, Address const & addr);
                                         ///< Connect to remote host
                                         /**< This member is only available if the socket handles
                                              communication policy is ConnectedCommunicationPolicy.
 
                                              \param[in] handle socket handle
-                                             \param[in] address address of remote peer to connect
+                                             \param[in] addr address of remote peer to connect
                                                  to */
+#       endif
         static void bind(FileHandle handle, Address const & addr);
                                         ///< Set local socket address
                                         /**< \param[in] handle socket handle
@@ -129,4 +139,6 @@ namespace senf {
 // c-file-style: "senf"
 // indent-tabs-mode: nil
 // ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
 // End: