Add documentation on private data member naming convention
[senf.git] / Socket / Protocols / UN / UNDatagramSocketHandle.hh
index 0956525..30e7b6b 100644 (file)
@@ -1,6 +1,7 @@
-// $Id$
-//
 // Copyright (C) 2007 
+// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
+// Kompetenzzentrum NETwork research (NET)
+//     David Wagner <david.wagner@fokus.fraunhofer.de>
 //
 // This program is free software; you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -33,8 +34,6 @@
 #include "../../../Socket/BufferingPolicy.hh"
 #include "../../../Socket/ProtocolClientSocketHandle.hh"
 
-
-
 //#include "UNDatagramSocketHandle.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 
@@ -55,7 +54,7 @@ namespace senf {
     /** \brief Unix Domain Datagram Socket Protocol
 
         \par Socket Handle typedefs:
-            \ref UNDatagramSocketHandle (ProtocolClientSocketHandle)
+            \ref UNDatagramClientSocketHandle (ProtocolClientSocketHandle)
 
         \par Policy Interface: (to be checked)
             ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
@@ -88,11 +87,11 @@ namespace senf {
                                         /**< \note This member is implicitly called from the
                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
                                              constructor */
-        void init_client(UNSocketAddress const & address) const;
+        void init_client(UNSocketAddress const & address) const; 
                                         ///< Create client socket and bind
                                         /**< Creates a new client socket and bind to the given
                                              address.
-                                             \param[in] local address to bind to */
+                                             \param[in] address local address to bind to */
                                         /**< \note This member is implicitly called from the
                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
                                              constructor */
@@ -107,10 +106,6 @@ namespace senf {
 
     typedef ProtocolClientSocketHandle<UNDatagramSocketProtocol> UNDatagramClientSocketHandle;
 
-    typedef MakeSocketPolicy<
-        UNDatagramSocket_Policy,
-        UNAddressingPolicy
-        >::policy UNDatagramSocket_Policy;
 }
 ///////////////////////////////hh.e////////////////////////////////////////
 //#include "UNDatagramSocketHandle.cci"