PPI: Checkin of first compiling (yet not working) version
[senf.git] / Socket / AddressingPolicy.hh
index b13ac1d..825c245 100644 (file)
@@ -1,6 +1,6 @@
 // $Id$
 //
-// Copyright (C) 2006 
+// Copyright (C) 2006
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
 //     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief NoAddressingPolicy public header
+ */
+
 #ifndef HH_AddressingPolicy_
 #define HH_AddressingPolicy_ 1
 
 //#include "AddressingPolicy.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 
-namespace satcom {
-namespace lib {
+namespace senf {
+
+    /// \addtogroup policy_impl_group
+    /// @{
+
+    /** \brief AddressingPolicy for non-addressable sockets
 
+        This is different from UndefinedAddressingPolicy (which is the
+        same as AddressingPolicyBase). This policy class defines the
+        addressing -- it explicitly states, that the socket does not
+        support any addressing.
+     */
     struct NoAddressingPolicy : public AddressingPolicyBase
     {};
 
-}}
+    /// @}
+}
 
 ///////////////////////////////hh.e////////////////////////////////////////
 //#include "AddressingPolicy.cci"
@@ -47,5 +61,10 @@ namespace lib {
 \f
 // Local Variables:
 // mode: c++
-// c-file-style: "satcom"
+// fill-column: 100
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
 // End: