Socket: some minor documentation (typo) fixes

[senf.git] / senf / Socket / Protocols / INet / INet6Address.hh

diff --git a/senf/Socket/Protocols/INet/INet6Address.hh b/senf/Socket/Protocols/INet/INet6Address.hh
index f5f700a..66cc026 100644 (file)
--- a/senf/Socket/Protocols/INet/INet6Address.hh
+++ b/senf/Socket/Protocols/INet/INet6Address.hh
@@ -86,7 +86,7 @@ namespace senf {
         <tr><td><tt>ff00::/8</tt></td>       <td>Multicast</td>                           <td>RFC4291</td>     <td></td></tr>
         <tr><td><tt>ff00::/12</tt></td>      <td>Globally allocated multicast</td>        <td>RFC4291</td>     <td></td></tr>
         <tr><td><tt>ff10::/12</tt></td>      <td>Locally allocated multicast</td>         <td>RFC4291</td>     <td></td></tr>
-        <tr><td><tt>ff30::/12</tt></td>      <td>Unicast prefic based multicast</td>      <td>RFC3306</td>     <td></td></tr>
+        <tr><td><tt>ff30::/12</tt></td>      <td>Unicast prefix based multicast</td>      <td>RFC3306</td>     <td></td></tr>
         <tr><td><tt>ff70::/12</tt></td>      <td>Multicast address with embedded RP</td>  <td>RFC3956</td>     <td></td></tr>
         </table>
         \endhtmlonly
@@ -176,12 +176,14 @@ 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
                                              \throws AddressSyntaxException if the address cannot be
                                                  converted for some reason
+                                             \throws UnknownHostnameException if the hostname cannot
+                                                 be resolved
                                              \param[in] s Address literal or hostname
                                              \param[in] resolve If this is set to \c ResolveINet4,
                                                  the call will additionally try to interpret \a s as
@@ -216,7 +218,7 @@ namespace senf {
                                         /**< This will construct a link local address of the form
                                              <tt>fe80::xxxx:xxxx:xxxx:xxxx</tt>. */
 
-        in6_addr toin6_addr() const;    ///< get the linux in6_addr struct (convinience only)
+        in6_addr toin6_addr() const;    ///< get the linux in6_addr struct (convenience only)
 
         ///@}
         ///////////////////////////////////////////////////////////////////////////
@@ -292,7 +294,9 @@ 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
@@ -394,6 +398,13 @@ namespace senf {
         \related INet6Network
      */
     std::ostream & operator<<(std::ostream & os, INet6Network const & addr);
+
+    /** \brief Try to initialize INet6Network instance from a string representation
+
+        sets std::ios::failbit on the stream if an error occurred
+        \related INet6Network
+     */
+    std::istream & operator>>(std::istream & is, INet6Network & addr);
 }
 
 ///////////////////////////////hh.e////////////////////////////////////////
@@ -402,7 +413,7 @@ namespace senf {
 #include "INet6Address.cti"
 #endif
 
-\f
+
 // Local Variables:
 // mode: c++
 // fill-column: 100