]> git.lizzy.rs Git - rust.git/commitdiff
Added links to std::net::AddrParseError's documentation
authorlukaramu <lukaramu@gmail.com>
Sat, 25 Mar 2017 18:23:13 +0000 (19:23 +0100)
committerlukaramu <lukaramu@gmail.com>
Sun, 26 Mar 2017 12:35:12 +0000 (14:35 +0200)
Additionally changed the summary sentence to be more consistent with most
of the other FromStr implementations' error types.

src/libstd/net/parser.rs

index d86711c10ac7965c9dfcb17ab474ce8e771c3875..7d7c67ff3f9f767fcc80801af177543767797851 100644 (file)
@@ -368,7 +368,19 @@ fn from_str(s: &str) -> Result<SocketAddr, AddrParseError> {
     }
 }
 
-/// 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(());