fixup: docs

mullvad · Jul 24, 2024 · c336c51 · c336c51
1 parent 00cd05c
commit c336c51
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/src/state.rs b/src/state.rs
@@ -29,9 +29,14 @@ impl State {
     /// # Safety
     ///
     /// `sync_state.lan` and `sync_state.ext_lan` must set an address and port:
-    /// * If `sync_state.af_lan == PF_INET`, then `host.addr.pfa._v4addr` must be initialized.
-    /// * If `sync_state.af_lan == PF_INET6`, then `host.addr.pfa._v6addr` must be initialized.
-    /// * `host.xport.port` must be initialized.
+    /// * If `sync_state.af_lan == PF_INET`, then these fields must be initialized:
+    ///   * `sync_state.lan.addr.pfa._v4addr`
+    ///   * `sync_state.ext_lan.addr.pfa._v4addr`
+    /// * If `sync_state.af_lan == PF_INET6`, then these fields must be initialized:
+    ///   * `sync_state.lan.addr.pfa._v6addr`
+    ///   * `sync_state.ext_lan.addr.pfa._v6addr`
+    /// * `sync_state.lan.xport.port` must be initialized.
+    /// * `sync_state.ext_lan.xport.port` must be initialized.
     pub(crate) unsafe fn new(sync_state: pfsync_state) -> State {
         State { sync_state }
     }