Skip to content

Commit bec682e

Browse files
tyethtyeth
committed
Doxygen comments for compareByRSSI
1 parent cdb96c7 commit bec682e

File tree

5 files changed

+75
-10
lines changed

5 files changed

+75
-10
lines changed

‎src/network_interfaces/Wippersnapper_AIRLIFT.h‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,26 @@ class Wippersnapper_AIRLIFT : public Wippersnapper {
103103
_pass = WS._config.network.pass;
104104
}
105105

106-
// Define a structure to hold network information
106+
/**********************************************************/
107+
/*!
108+
@brief a structure to hold network information
109+
*/
110+
/**********************************************************/
107111
struct WiFiNetwork {
108112
char ssid[33]; // Maximum SSID length is 32 characters + null terminator
109113
int rssi;
110114
};
111115

112-
// Comparison function to sort by RSSI in descending order
116+
/*******************************************************************/
117+
/*!
118+
@brief Comparison function to sort by RSSI in descending order
119+
@param a
120+
WiFiNetwork object
121+
@param b
122+
WiFiNetwork object
123+
@returns True if a.rssi > b.rssi
124+
*/
125+
/*******************************************************************/
113126
bool static compareByRSSI(const WiFiNetwork &a, const WiFiNetwork &b) {
114127
return a.rssi > b.rssi;
115128
}

‎src/network_interfaces/Wippersnapper_ESP32.h‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,26 @@ class Wippersnapper_ESP32 : public Wippersnapper {
9292
_pass = WS._config.network.pass;
9393
}
9494

95-
// Define a structure to hold network information
95+
/**********************************************************/
96+
/*!
97+
@brief a structure to hold network information
98+
*/
99+
/**********************************************************/
96100
struct WiFiNetwork {
97101
char ssid[33]; // Maximum SSID length is 32 characters + null terminator
98102
int rssi;
99103
};
100104

101-
// Comparison function to sort by RSSI in descending order
105+
/*******************************************************************/
106+
/*!
107+
@brief Comparison function to sort by RSSI in descending order
108+
@param a
109+
WiFiNetwork object
110+
@param b
111+
WiFiNetwork object
112+
@returns True if a.rssi > b.rssi
113+
*/
114+
/*******************************************************************/
102115
bool static compareByRSSI(const WiFiNetwork &a, const WiFiNetwork &b) {
103116
return a.rssi > b.rssi;
104117
}

‎src/network_interfaces/Wippersnapper_ESP8266.h‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,26 @@ class Wippersnapper_ESP8266 : public Wippersnapper {
115115
_pass = WS._config.network.pass;
116116
}
117117

118-
// Define a structure to hold network information
118+
/**********************************************************/
119+
/*!
120+
@brief a structure to hold network information
121+
*/
122+
/**********************************************************/
119123
struct WiFiNetwork {
120124
char ssid[33]; // Maximum SSID length is 32 characters + null terminator
121125
int rssi;
122126
};
123127

124-
// Comparison function to sort by RSSI in descending order
128+
/*******************************************************************/
129+
/*!
130+
@brief Comparison function to sort by RSSI in descending order
131+
@param a
132+
WiFiNetwork object
133+
@param b
134+
WiFiNetwork object
135+
@returns True if a.rssi > b.rssi
136+
*/
137+
/*******************************************************************/
125138
bool static compareByRSSI(const WiFiNetwork &a, const WiFiNetwork &b) {
126139
return a.rssi > b.rssi;
127140
}

‎src/network_interfaces/Wippersnapper_WIFININA.h‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,26 @@ class Wippersnapper_WIFININA : public Wippersnapper {
111111
strlcpy(WS._config.network.pass, _pass, sizeof(WS._config.network.pass));
112112
}
113113

114-
// Define a structure to hold network information
114+
/**********************************************************/
115+
/*!
116+
@brief a structure to hold network information
117+
*/
118+
/**********************************************************/
115119
struct WiFiNetwork {
116120
char ssid[33]; // Maximum SSID length is 32 characters + null terminator
117121
int rssi;
118122
};
119123

120-
// Comparison function to sort by RSSI in descending order
124+
/*******************************************************************/
125+
/*!
126+
@brief Comparison function to sort by RSSI in descending order
127+
@param a
128+
WiFiNetwork object
129+
@param b
130+
WiFiNetwork object
131+
@returns True if a.rssi > b.rssi
132+
*/
133+
/*******************************************************************/
121134
bool static compareByRSSI(const WiFiNetwork &a, const WiFiNetwork &b) {
122135
return a.rssi > b.rssi;
123136
}

‎src/network_interfaces/ws_networking_pico.h‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,26 @@ class ws_networking_pico : public Wippersnapper {
9494
_pass = WS._config.network.pass;
9595
}
9696

97-
// Define a structure to hold network information
97+
/**********************************************************/
98+
/*!
99+
@brief a structure to hold network information
100+
*/
101+
/**********************************************************/
98102
struct WiFiNetwork {
99103
char ssid[33]; // Maximum SSID length is 32 characters + null terminator
100104
int rssi;
101105
};
102106

103-
// Comparison function to sort by RSSI in descending order
107+
/*******************************************************************/
108+
/*!
109+
@brief Comparison function to sort by RSSI in descending order
110+
@param a
111+
WiFiNetwork object
112+
@param b
113+
WiFiNetwork object
114+
@returns True if a.rssi > b.rssi
115+
*/
116+
/*******************************************************************/
104117
bool static compareByRSSI(const WiFiNetwork &a, const WiFiNetwork &b) {
105118
return a.rssi > b.rssi;
106119
}

0 commit comments

Comments
 (0)