Add some docs.

whitequark · whitequark · commit 2d31ef966532 · 2017-09-24T23:29:42.000Z
diff --git a/src/wire/ethernet.rs b/src/wire/ethernet.rs
@@ -28,6 +28,7 @@ impl fmt::Display for EtherType {
 pub struct Address(pub [u8; 6]);
 
 impl Address {
+    /// The broadcast address.
     pub const BROADCAST: Address = Address([0xff; 6]);
 
     /// Construct an Ethernet address from a sequence of octets, in big-endian.
diff --git a/src/wire/ip.rs b/src/wire/ip.rs
@@ -135,6 +135,7 @@ pub struct Endpoint {
 }
 
 impl Endpoint {
+    /// An endpoint with unspecified address and port.
     pub const UNSPECIFIED: Endpoint = Endpoint { addr: Address::Unspecified, port: 0 };
 
     /// Create an endpoint address from given address and port.
diff --git a/src/wire/ipv4.rs b/src/wire/ipv4.rs
@@ -12,7 +12,10 @@ pub use super::IpProtocol as Protocol;
 pub struct Address(pub [u8; 4]);
 
 impl Address {
+    /// An unspecified address.
     pub const UNSPECIFIED: Address = Address([0x00; 4]);
+
+    /// The broadcast address.
     pub const BROADCAST:   Address = Address([0xff; 4]);
 
     /// Construct an IPv4 address from parts.

Original file line number	Diff line number	Diff line change
`@@ -135,6 +135,7 @@ pub struct Endpoint {`
`135`	`135`	`}`
`136`	`136`
`137`	`137`	`impl Endpoint {`
	`138`	`+ /// An endpoint with unspecified address and port.`
`138`	`139`	`pub const UNSPECIFIED: Endpoint = Endpoint { addr: Address::Unspecified, port: 0 };`
`139`	`140`
`140`	`141`	`/// Create an endpoint address from given address and port.`