Document DHCPv4 client.

Author: astro

src/dhcp/clientv4.rs

@@ -61,7 +61,27 @@ pub struct Client {
 /// You must call `poll()` after `iface.poll()` to send and receive
 /// DHCP packets.
 impl Client {
-    /// TODO
+    /// # Usage
+    /// ```rust
+    /// use smoltcp::socket::{SocketSet, RawSocketBuffer, RawPacketMetadata};
+    /// use smoltcp::dhcp::Dhcpv4Client;
+    /// use smoltcp::time::Instant;
+    ///
+    /// let mut sockets = SocketSet::new(vec![]);
+    /// let dhcp_rx_buffer = RawSocketBuffer::new(
+    ///     [RawPacketMetadata::EMPTY; 1],
+    ///     vec![0; 1500]
+    /// );
+    /// let dhcp_tx_buffer = RawSocketBuffer::new(
+    ///     [RawPacketMetadata::EMPTY; 1],
+    ///     vec![0; 3000]
+    /// );
+    /// let mut dhcp = Dhcpv4Client::new(
+    ///     &mut sockets,
+    ///     dhcp_rx_buffer, dhcp_tx_buffer,
+    ///     Instant::now()
+    /// );
+    /// ```
     pub fn new<'a, 'b, 'c>(sockets: &mut SocketSet<'a, 'b, 'c>, rx_buffer: RawSocketBuffer<'b, 'c>, tx_buffer: RawSocketBuffer<'b, 'c>, now: Instant) -> Self
     where 'b: 'c,
     {
@@ -320,6 +340,8 @@ impl Client {
         self.next_egress = now;
     }
 
+    /// Returns iterable set of DNS servers as received from the DHCP
+    /// server.
     pub fn dns_servers(&self) -> DnsServers {
         DnsServers {
             dns_servers: &self.dns_servers,