X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FFramingPolicy.hh;h=a873239d0fe87521cd185f79d30ad94a3eb112c7;hb=d0006132bfcb3ab442cf66b600ed3fad36f1ac2c;hp=97a440c263bc571ffc9d2a28d5d571e459a1d359;hpb=5a5c6d7f0fae7ad6c0af49d7742955cb6cf618cf;p=senf.git

diff --git a/Socket/FramingPolicy.hh b/Socket/FramingPolicy.hh
index 97a440c..a873239 100644
--- 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////////////////////////////////////////