added documentation. hopefully enough and correct.

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@447 270642c3-0616-0410-b53a-bc976706d245

diff --git a/Socket/Protocols/UN/UNAddress.hh b/Socket/Protocols/UN/UNAddress.hh
index 36d4ffc..67a7061 100644 (file)
--- a/Socket/Protocols/UN/UNAddress.hh
+++ b/Socket/Protocols/UN/UNAddress.hh
@@ -32,17 +32,27 @@
 //#include "UNAddress.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 namespace senf {
+    /** \brief Unix domain address
+        
+        UNAddress represents a simple unix domain address which is given by a path to a socket. 
+        It is modelled as a boost::filesystem::path.
+
+        \ingroup addr_group
+      */
     class UNAddress 
         : public boost::filesystem::path,
           public ComparableSafeBool<UNAddress>
     {   
     public: 
-        UNAddress(); 
-        explicit UNAddress(boost::filesystem::path);
-        static UNAddress fromString(std::string & s);
-        static UNAddress fromPath(boost::filesystem::path & p);
-        static std::string pathString();
-        struct AddressException : public std::exception {};
+        UNAddress(); ///< Construct an empty address
+        explicit UNAddress(boost::filesystem::path);///< Construct an address constant from given path
+        static UNAddress fromString(std::string & s); ///< Convert string to address by interpreting the string as path
+        static UNAddress fromPath(boost::filesystem::path & p);///< Convert path to address 
+        static std::string pathString(); ///< Return the path of the address as string
+
+        /** \brief Base-class for UNAddress exceptions */
+        struct AddressException : public std::exception {}; 
+
     private:
         static boost::filesystem::path path;
     };

diff --git a/Socket/Protocols/UN/UNAddressing.hh b/Socket/Protocols/UN/UNAddressing.hh
index 4529e91..25b02d9 100644 (file)
--- a/Socket/Protocols/UN/UNAddressing.hh
+++ b/Socket/Protocols/UN/UNAddressing.hh
@@ -40,26 +40,56 @@
 //#include "UNAddressing.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 namespace senf {
+    /** \brief Unix domain socket address
+
+        UNSocketAddress wraps the standard sockaddr_in datatype. It provides simple accessor methods
+        to access the path. 
+        
+        \implementation This implementation is based on sockaddr_un.
+
+        \ingroup addr_group
+     */
     class UNSocketAddress
         : public ComparableSafeBool<UNSocketAddress>
     {
     public:
 
-        //UNSocketAddress();
+        //UNSocketAddress(); 
         explicit UNSocketAddress(boost::filesystem::path p);
-                                        ///< Construct an address constant
-        static UNSocketAddress from_string(std::string const s);
-        static UNSocketAddress from_path(boost::filesystem::path const p);
-        static std::string path();
+                                        ///< Construct an address constant from given path
+        static UNSocketAddress from_string(std::string const s); ///< Create UNSocketAddress from string
+        static UNSocketAddress from_path(boost::filesystem::path const p); ///< Create UNSocketAddress from path
+        static std::string path();  ///< Return path as string
         static sockaddr_un sockaddr(); 
+
         struct sockaddr * sockaddr_p();
         struct sockaddr const * sockaddr_p() const;
         unsigned sockaddr_len() const;
     private:
         static struct sockaddr_un sockAddr;
     };
+
+    /** \brief Write path  os
+
+        \related UNSocketAddress
+     */
     std::ostream & operator<<(std::ostream & os, UNSocketAddress const & addr);
 
+    /// \addtogroup policy_impl_group
+    /// @{
+
+    /** \brief Addressing policy supporting unix domain addressing
+
+        \par Address Type:
+            UNAddress
+
+        This addressing policy implements addressing using unix domain
+        addresses.
+
+        The various members are directly imported from
+        GenericAddressingPolicy which see for a detailed
+        documentation.
+     */
 
     struct UNAddressingPolicy
         : public AddressingPolicyBase,

diff --git a/Socket/Protocols/UN/UNDatagramSocketHandle.hh b/Socket/Protocols/UN/UNDatagramSocketHandle.hh
index a253105..458a958 100644 (file)
--- a/Socket/Protocols/UN/UNDatagramSocketHandle.hh
+++ b/Socket/Protocols/UN/UNDatagramSocketHandle.hh
@@ -50,8 +50,27 @@ namespace senf {
         ReadablePolicy,
         WriteablePolicy,
         SocketBufferingPolicy
-        >::policy UNDatagramSocket_Policy;   
+        >::policy UNDatagramSocket_Policy;   ///< Socket Policy of the Unix Domain Datagram Protocol
 
+    /** \brief Unix Domain Datagram Socket Protocol
+
+        \par Socket Handle typedefs:
+            \ref UNDatagramSocketHandle (ProtocolClientSocketHandle)
+
+        \par Policy Interface: (to be checked)
+            ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
+            ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(),
+            ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
+
+        \par Address Type:
+            UNAddress
+
+        UNDatagramSocketProtocol provides an datagram protocol socket based on the unix domain  addressing.
+
+        This class is utilized as the protocol class of the ProtocolClientSocketHandle
+        via the Socket Handle typedefs above.
+
+    */
     class UNDatagramSocketProtocol
         : public ConcreteSocketProtocol<UNDatagramSocket_Policy>,
           public UNProtocol, 

diff --git a/Socket/Protocols/UN/UNProtocol.hh b/Socket/Protocols/UN/UNProtocol.hh
index 3434641..578bc86 100644 (file)
--- a/Socket/Protocols/UN/UNProtocol.hh
+++ b/Socket/Protocols/UN/UNProtocol.hh
@@ -49,11 +49,11 @@ namespace senf {
         : public virtual SocketProtocol
     {
     public:
-        void connect(UNSocketAddress const & address) const; ///< Connect to remote address
+        void connect(UNSocketAddress const & address) const; ///< Connect to a  unix domain socket 
                                         /**< \todo make this obsolete by allowing access to the
                                              ClientSocketHandle from ConcreateSocketProtocol
                                              \param[in] address Address to connect to */
-        void bind(UNSocketAddress const & address) const; ///< Set local socket address
+        void bind(UNSocketAddress const & address) const; ///< Set local socket address (path)
                                         /**< \todo make this obsolete by allowing access to the
                                              ClientSocketHandle from ConcreateSocketProtocol
                                              \param[in] address Address to set */