Fix documentation typos

[senf.git] / Socket / FramingPolicy.hh

diff --git a/Socket/FramingPolicy.hh b/Socket/FramingPolicy.hh
index 97a440c..a873239 100644 (file)
--- a/Socket/FramingPolicy.hh
+++ b/Socket/FramingPolicy.hh
@@ -20,6 +20,10 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief FramingPolicy public header
+ */
+
 #ifndef HH_FramingPolicy_
 #define HH_FramingPolicy_ 1
 
@@ -31,13 +35,33 @@
 
 namespace senf {
 
+    /// \addtogroup policy_impl_group
+    /// @{
 
+    /** \brief FramingPolicy for stream oriented sockets
+       
+       This policy does not explicitly modify the SocketHAndle
+       API. It however affects the semantics of the read and write
+       operations. On a stream oriented socket, read() and write()
+       operations may be combined, the boundary between separate
+       write() calls will be lost on the receiving side.
+     */
     struct StreamFramingPolicy : public FramingPolicyBase
     {};
 
+    /** \brief FramingPolicy for datagram oriented sockets
+
+       This policy does not explicitly modify the SocketHAndle
+       API. It however affects the semantics of the read and write
+       operations. On a datagram socket, each read() or write() call
+       we read or write a single datagram. Datagram boundaries are
+       kept intact accross the network.
+     */
     struct DatagramFramingPolicy : public FramingPolicyBase
     {};
 
+    /// @}
+
 }
 
 ///////////////////////////////hh.e////////////////////////////////////////