about summary refs log tree commit diff
diff options
context:
space:
mode:
authorlukaramu <lukaramu@gmail.com>2017-03-25 19:23:13 +0100
committerlukaramu <lukaramu@gmail.com>2017-03-26 14:35:12 +0200
commit0d5baba70d3adbb2a8ea436c6c89f21c1c6927b8 (patch)
tree75da50d2ae20c36596479b3bcd8ce84ce3239196
parentdf5830a4ece5eae8451e7b3d4f77b8af92a9f9fc (diff)
downloadrust-0d5baba70d3adbb2a8ea436c6c89f21c1c6927b8.tar.gz
rust-0d5baba70d3adbb2a8ea436c6c89f21c1c6927b8.zip
Added links to std::net::AddrParseError's documentation
Additionally changed the summary sentence to be more consistent with most
of the other FromStr implementations' error types.
-rw-r--r--src/libstd/net/parser.rs14
1 files changed, 13 insertions, 1 deletions
diff --git a/src/libstd/net/parser.rs b/src/libstd/net/parser.rs
index d86711c10ac..7d7c67ff3f9 100644
--- a/src/libstd/net/parser.rs
+++ b/src/libstd/net/parser.rs
@@ -368,7 +368,19 @@ impl FromStr for SocketAddr {
     }
 }
 
-/// An error returned when parsing an IP address or a socket address.
+/// An error which can be returned when parsing an IP address or a socket address.
+///
+/// This error is used as the error type for the [`FromStr`] implementation for
+/// [`IpAddr`], [`Ipv4Addr`], [`Ipv6Addr`], [`SocketAddr`], [`SocketAddrV4`], and
+/// [`SocketAddrV6`].
+///
+/// [`FromStr`]: ../../std/str/trait.FromStr.html
+/// [`IpAddr`]: ../../std/net/enum.IpAddr.html
+/// [`Ipv4Addr`]: ../../std/net/struct.Ipv4Addr.html
+/// [`Ipv6Addr`]: ../../std/net/struct.Ipv6Addr.html
+/// [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
+/// [`SocketAddrV4`]: ../../std/net/struct.SocketAddrV4.html
+/// [`SocketAddrV6`]: ../../std/net/struct.SocketAddrV6.html
 #[stable(feature = "rust1", since = "1.0.0")]
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct AddrParseError(());