Added doc comment to a public enum variant

This commit is contained in:
Vicente 2024-07-25 20:01:19 +02:00
parent da5ecd29f1
commit 29d79d3af2

View File

@ -46,6 +46,7 @@ pub enum ScanType {
#[derive(Clone)] #[derive(Clone)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))] #[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct ScanOptions { pub struct ScanOptions {
/// SSID to scan for.
pub ssid: Option<heapless::String<32>>, pub ssid: Option<heapless::String<32>>,
/// If set to `None`, all APs will be returned. If set to `Some`, only APs /// If set to `None`, all APs will be returned. If set to `Some`, only APs
/// with the specified BSSID will be returned. /// with the specified BSSID will be returned.