Socket/Protocols/INet: added documentation for new address input streaming

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

diff --git a/Socket/Protocols/INet/INet4Address.hh b/Socket/Protocols/INet/INet4Address.hh
index e69c224..b41369a 100644 (file)
--- a/Socket/Protocols/INet/INet4Address.hh
+++ b/Socket/Protocols/INet/INet4Address.hh
@@ -114,7 +114,7 @@ namespace senf {
                                         ///< Convert string to address
                                         /**< This member will try to convert the given string into
                                              an IP address. from_string() supports all standard IP
-                                             literal representations as well es hostnames.
+                                             literal representations as well as hostnames.
                                              \attention This call may block if \a s represents a
                                                  hostname which must be looked up via some network
                                                  protocol like DNS or NIS
@@ -175,6 +175,11 @@ namespace senf {
         \related INet4Address
      */
     std::ostream & operator<<(std::ostream & os, INet4Address const & addr);
+    /** \brief Try to initialize INet4Address instance from a string representation
+        sets std::ios::failbit on the stream if an error occurred
+        \see INet4Address from_string()
+        \related INet4Address
+     */
     std::istream & operator>>(std::istream & os, INet4Address & addr);
 
     /** \brief CHeck INet4Address against a fixed network prefix

diff --git a/Socket/Protocols/INet/INet6Address.hh b/Socket/Protocols/INet/INet6Address.hh
index 600ed57..e2bad76 100644 (file)
--- a/Socket/Protocols/INet/INet6Address.hh
+++ b/Socket/Protocols/INet/INet6Address.hh
@@ -283,6 +283,11 @@ namespace senf {
         \related INet6Address
      */
     std::ostream & operator<<(std::ostream & os, INet6Address const & addr);
+    /** \brief Try to initialize INet6Address instance from a string representation
+        sets std::ios::failbit on the stream if an error occurred
+        \see INet6Address from_string()
+        \related INet6Address
+     */
     std::istream & operator>>(std::istream & is, INet6Address & addr);
 
     /** \brief Check INet6Address against a fixed network prefix