Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Socket / Protocols / INet / RawINetSocketHandle.hh
index 02f71ef..9d15a45 100644 (file)
 #include <senf/Socket/ProtocolClientSocketHandle.hh>
 
 
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
 
     /// \addtogroup concrete_protocol_group
-    /// @{
+    //\{
 
     typedef MakeSocketPolicy<
         INet4AddressingPolicy,
@@ -64,9 +64,9 @@ namespace senf {
             INet4SocketAddress
 
         RawV4SocketProtocol provides an internet protocol raw socket based on IPv4 addressing.
-        This socket will put data written to it onto the IPv4 layer: if you call writeto don't inlude the header!
-        On the other hand `read` will return the packet data including the IP header. 
-        This behaviour is strange and differs from the behaviour of IPv6 RAW sockets and should be changed in the future. 
+        This socket will put data written to it onto the IPv4 layer: if you call writeto don't include the header!
+        On the other hand `read` will return the packet data including the IP header.
+        This behaviour is strange and differs from the behaviour of IPv6 RAW sockets and should be changed in the future.
 
         This class is utilized as the protocol class of the ProtocolClientSocketHandle
         via the Socket Handle typedefs above.
@@ -86,26 +86,26 @@ namespace senf {
           public INet4MulticastSocketProtocol
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         // internal interface
 
         ///\name Constructors
-        ///@{
+        //\{
 
         void init_client() const;       ///< Create unconnected client socket for IPPROTO_RAW
                                         /**< \note This member is implicitly called from the
                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
                                              constructor */
         void init_client(int const & protocol) const;       ///< Create unconnected client socket for protocol
-        
+
         void init_client(int const & protocol, INet4SocketAddress const & address) const;
                                         ///< Create client socket and bind
                                         /**< Creates a new client socket for the given protocol and binds to the given
                                              address.
-                                             \param[in] protocol Layer 4 protocol to filter for / to send 
+                                             \param[in] protocol Layer 4 protocol to filter for / to send
                                              \param[in] address local address to bind to */
 
-        ///@}
+        //\}
     };
 
     typedef ProtocolClientSocketHandle<RawV4SocketProtocol> RawV4ClientSocketHandle;
@@ -113,7 +113,7 @@ namespace senf {
 
 
 
-//////////////////////////////////////////////////////////////////// Raw IPv6 Socket //////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
     typedef MakeSocketPolicy<
         INet6AddressingPolicy,
         DatagramFramingPolicy,
@@ -127,7 +127,7 @@ namespace senf {
         \par Socket Handle typedefs:
         \ref RawV6ClientSocketHandle (ProtocolClientSocketHandle)
 
-        \par Policy Interface: 
+        \par Policy Interface:
             ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
             ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local()
 
@@ -135,9 +135,9 @@ namespace senf {
             INet6Address
 
         RawV6SocketProtocol provides an internet protocol raw socket based on IPv6 addressing.
-        This socket will put data written to it onto the IPv6 layer: if you call writeto don't inlude the header!
-        On the other hand `read` will return the packet data on top of the IPv6 layer, excluding the IP header. 
-        Note: This behaviour is differs from the behaviour of IPv4 RAW sockets. 
+        This socket will put data written to it onto the IPv6 layer: if you call writeto don't include the header!
+        On the other hand `read` will return the packet data on top of the IPv6 layer, excluding the IP header.
+        Note: This behaviour is differs from the behaviour of IPv4 RAW sockets.
 
         This class is utilized as the protocol class of the ProtocolClientSocketHandle
         via the Socket Handle typedefs above.
@@ -157,11 +157,11 @@ namespace senf {
           public INet6MulticastSocketProtocol
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         // internal interface
 
         ///\name Constructors
-        ///@{
+        //\{
 
         void init_client() const;       ///< Create unconnected client socket for IPPROTO_RAW
                                         /**< \note This member is implicitly called from the
@@ -174,18 +174,18 @@ namespace senf {
                                         ///< Create client socket and bind
                                         /**< Creates a new client socket for the given protocol and binds to the given
                                              address.
-                                             \param[in] protocol Layer 4 protocol to filter for / to send 
+                                             \param[in] protocol Layer 4 protocol to filter for / to send
                                              \param[in] address local address to bind to */
                                         /**< \note This member is implicitly called from the
                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
                                              constructor */
 
-        ///@}
+        //\}
     };
 
     typedef ProtocolClientSocketHandle<RawV6SocketProtocol> RawV6ClientSocketHandle;
 
-    /// @}
+    //\}
 
 }