Add INPUT_FILTER support do Doxygen builder

[senf.git] / Socket / TCPSocketHandle.hh

diff --git a/Socket/TCPSocketHandle.hh b/Socket/TCPSocketHandle.hh
index 5d3b2c0..a566d93 100644 (file)
--- a/Socket/TCPSocketHandle.hh
+++ b/Socket/TCPSocketHandle.hh
@@ -20,8 +20,11 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// TODO: Implement possibly non-blocking connect and SO_ERROR in the
-// protocol interface
+/** \file
+
+    \todo Implement possibly non-blocking connect and SO_ERROR in the
+    protocol interface
+ */
 
 #ifndef HH_TCPSocketHandle_
 #define HH_TCPSocketHandle_ 1
@@ -40,8 +43,10 @@
 //#include "TCPSocketHandle.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 
-namespace satcom {
-namespace lib {
+namespace senf {
+
+    /// \addtogroup concrete_protocol_group
+    /// @{
 
     typedef MakeSocketPolicy<
         INet4AddressingPolicy,
@@ -50,8 +55,10 @@ namespace lib {
         ReadablePolicy,
         WriteablePolicy,
         SocketBufferingPolicy
-        >::policy TCPv4Socket_Policy;
+        >::policy TCPv4Socket_Policy;   ///< Socket Policy of the TCPv4 Protocol
 
+    /** \brief
+     */
     class TCPv4SocketProtocol
         : public ConcreteSocketProtocol<TCPv4Socket_Policy>,
           public IPv4Protocol, 
@@ -63,12 +70,20 @@ namespace lib {
         ///////////////////////////////////////////////////////////////////////////
         // internal interface
 
+       ///\name Constructors
+       ///@{
+
         void init_client() const;
         void init_client(INet4Address const & address) const;
         void init_server() const;
         void init_server(INet4Address const & address, unsigned backlog=1) const;
 
+       ///@}
+       ///\name Abstract Interface Implementation
+
         std::auto_ptr<SocketProtocol> clone() const;
+       
+       ///@}
     };
 
     typedef ProtocolClientSocketHandle<TCPv4SocketProtocol> TCPv4ClientSocketHandle;
@@ -86,13 +101,15 @@ namespace lib {
           public BSDSocketProtocol,
           public AddressableBSDSocketProtocol
     {
-        // TODO: Implement
+        /** \todo Implement */
     };
 
     typedef ProtocolClientSocketHandle<TCPv6SocketProtocol> TCPv6ClientSocketHandle;
     typedef ProtocolServerSocketHandle<TCPv6SocketProtocol> TCPv6ServerSocketHandle;
 
-}}
+    /// @}
+
+}
 
 ///////////////////////////////hh.e////////////////////////////////////////
 //#include "TCPSocketHandle.cci"
@@ -103,5 +120,5 @@ namespace lib {
 \f
 // Local Variables:
 // mode: c++
-// c-file-style: "satcom"
+// c-file-style: "senf"
 // End: