From dfcd1d9220ddd83b0ed533ebb1c992b5c38753f5 Mon Sep 17 00:00:00 2001
From: tho <tho@wiback.org>
Date: Mon, 9 Feb 2009 10:45:07 +0000
Subject: [PATCH] Socket/Protocols/INet: added documentation for new address
input streaming
---
Socket/Protocols/INet/INet4Address.hh | 7 ++++++-
Socket/Protocols/INet/INet6Address.hh | 5 +++++
2 files changed, 11 insertions(+), 1 deletion(-)
diff --git a/Socket/Protocols/INet/INet4Address.hh b/Socket/Protocols/INet/INet4Address.hh
index e69c22459..b41369aa8 100644
--- 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 600ed57b3..e2bad767e 100644
--- 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
--
GitLab