From 806690f98a6ed48445b8e7679845e1fb6fc6c35d Mon Sep 17 00:00:00 2001 From: tyeth Date: Thu, 14 Nov 2024 19:11:10 +0000 Subject: [PATCH] Document wifi network struct for sorting --- src/network_interfaces/Wippersnapper_AIRLIFT.h | 10 +++++----- src/network_interfaces/Wippersnapper_ESP32.h | 10 +++++----- src/network_interfaces/Wippersnapper_ESP8266.h | 10 +++++----- src/network_interfaces/Wippersnapper_WIFININA.h | 10 +++++----- src/network_interfaces/ws_networking_pico.h | 10 +++++----- 5 files changed, 25 insertions(+), 25 deletions(-) diff --git a/src/network_interfaces/Wippersnapper_AIRLIFT.h b/src/network_interfaces/Wippersnapper_AIRLIFT.h index f4632500..b08fde4f 100644 --- a/src/network_interfaces/Wippersnapper_AIRLIFT.h +++ b/src/network_interfaces/Wippersnapper_AIRLIFT.h @@ -103,14 +103,14 @@ class Wippersnapper_AIRLIFT : public Wippersnapper { _pass = WS._config.network.pass; } - /**********************************************************/ + /****************************************************************/ /*! - @brief a structure to hold network information + @brief a structure to hold network information for sorting */ - /**********************************************************/ + /****************************************************************/ struct WiFiNetwork { - char ssid[33]; // Maximum SSID length is 32 characters + null terminator - int rssi; + char ssid[33]; /*!< SSID (Max 32 characters + null terminator */ + int rssi; /*!< Received Signal Strength Indicator */ }; /*******************************************************************/ diff --git a/src/network_interfaces/Wippersnapper_ESP32.h b/src/network_interfaces/Wippersnapper_ESP32.h index 212c844d..afb388b8 100644 --- a/src/network_interfaces/Wippersnapper_ESP32.h +++ b/src/network_interfaces/Wippersnapper_ESP32.h @@ -92,14 +92,14 @@ class Wippersnapper_ESP32 : public Wippersnapper { _pass = WS._config.network.pass; } - /**********************************************************/ + /****************************************************************/ /*! - @brief a structure to hold network information + @brief a structure to hold network information for sorting */ - /**********************************************************/ + /****************************************************************/ struct WiFiNetwork { - char ssid[33]; // Maximum SSID length is 32 characters + null terminator - int rssi; + char ssid[33]; /*!< SSID (Max 32 characters + null terminator */ + int rssi; /*!< Received Signal Strength Indicator */ }; /*******************************************************************/ diff --git a/src/network_interfaces/Wippersnapper_ESP8266.h b/src/network_interfaces/Wippersnapper_ESP8266.h index c9ca6b58..72196b15 100644 --- a/src/network_interfaces/Wippersnapper_ESP8266.h +++ b/src/network_interfaces/Wippersnapper_ESP8266.h @@ -115,14 +115,14 @@ class Wippersnapper_ESP8266 : public Wippersnapper { _pass = WS._config.network.pass; } - /**********************************************************/ + /****************************************************************/ /*! - @brief a structure to hold network information + @brief a structure to hold network information for sorting */ - /**********************************************************/ + /****************************************************************/ struct WiFiNetwork { - char ssid[33]; // Maximum SSID length is 32 characters + null terminator - int rssi; + char ssid[33]; /*!< SSID (Max 32 characters + null terminator */ + int rssi; /*!< Received Signal Strength Indicator */ }; /*******************************************************************/ diff --git a/src/network_interfaces/Wippersnapper_WIFININA.h b/src/network_interfaces/Wippersnapper_WIFININA.h index cb8e9148..3ed693d1 100644 --- a/src/network_interfaces/Wippersnapper_WIFININA.h +++ b/src/network_interfaces/Wippersnapper_WIFININA.h @@ -111,14 +111,14 @@ class Wippersnapper_WIFININA : public Wippersnapper { strlcpy(WS._config.network.pass, _pass, sizeof(WS._config.network.pass)); } - /**********************************************************/ + /****************************************************************/ /*! - @brief a structure to hold network information + @brief a structure to hold network information for sorting */ - /**********************************************************/ + /****************************************************************/ struct WiFiNetwork { - char ssid[33]; // Maximum SSID length is 32 characters + null terminator - int rssi; + char ssid[33]; /*!< SSID (Max 32 characters + null terminator */ + int rssi; /*!< Received Signal Strength Indicator */ }; /*******************************************************************/ diff --git a/src/network_interfaces/ws_networking_pico.h b/src/network_interfaces/ws_networking_pico.h index ace0ea22..19eeafa3 100644 --- a/src/network_interfaces/ws_networking_pico.h +++ b/src/network_interfaces/ws_networking_pico.h @@ -94,14 +94,14 @@ class ws_networking_pico : public Wippersnapper { _pass = WS._config.network.pass; } - /**********************************************************/ + /****************************************************************/ /*! - @brief a structure to hold network information + @brief a structure to hold network information for sorting */ - /**********************************************************/ + /****************************************************************/ struct WiFiNetwork { - char ssid[33]; // Maximum SSID length is 32 characters + null terminator - int rssi; + char ssid[33]; /*!< SSID (Max 32 characters + null terminator */ + int rssi; /*!< Received Signal Strength Indicator */ }; /*******************************************************************/