From 2455fd4dbe4e874a9a200d3026f66d437449b04d Mon Sep 17 00:00:00 2001
From: Ruben De Smet <ruben.de.smet@rubdos.be>
Date: Wed, 7 Jun 2023 12:08:53 +0200
Subject: [PATCH] net: Add documentation to new Config system

---
 embassy-net/src/lib.rs | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/embassy-net/src/lib.rs b/embassy-net/src/lib.rs
index cf7ebad3f..7e8f765f9 100644
--- a/embassy-net/src/lib.rs
+++ b/embassy-net/src/lib.rs
@@ -128,13 +128,16 @@ impl Default for DhcpConfig {
 
 /// Network stack configuration.
 pub struct Config {
+    /// IPv4 configuration
     #[cfg(feature = "proto-ipv4")]
     pub ipv4: ConfigV4,
+    /// IPv6 configuration
     #[cfg(feature = "proto-ipv6")]
     pub ipv6: ConfigV6,
 }
 
 impl Config {
+    /// IPv4 configuration with static addressing.
     #[cfg(feature = "proto-ipv4")]
     pub fn ipv4_static(config: StaticConfigV4) -> Self {
         Self {
@@ -144,6 +147,7 @@ impl Config {
         }
     }
 
+    /// IPv6 configuration with static addressing.
     #[cfg(feature = "proto-ipv6")]
     pub fn ipv6_static(config: StaticConfigV6) -> Self {
         Self {
@@ -153,6 +157,12 @@ impl Config {
         }
     }
 
+    /// IPv6 configuration with dynamic addressing.
+    ///
+    /// # Example
+    /// ```rust
+    /// let _cfg = Config::dhcpv4(Default::default());
+    /// ```
     #[cfg(feature = "dhcpv4")]
     pub fn dhcpv4(config: DhcpConfig) -> Self {
         Self {