Skip to content

Commit 8f5e003

Browse files
Jarno LamsaSeppo Takalo
authored andcommitted
WifiInterface doxygen cleanup
1 parent 501f5ae commit 8f5e003

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

features/netsocket/WiFiInterface.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,15 @@ class WiFiInterface: public virtual NetworkInterface {
9191

9292
/** Scan for available networks.
9393
*
94-
* This function will block. If the count is 0, function will only return count of available networks, so that
95-
* user can allocated necessary memory. If the count is grater than 0 and the a \p res is not NULL it'll be populated
96-
* with discovered networks up to value of count.
94+
* @note This is a blocking function.
95+
*
96+
* If the \p count is 0, the function only returns the number of available networks.
97+
* If the \p count is greater than 0 and the \p res is not NULL, the array of discovered APs is populated
98+
* with discovered networks up to the value of the \p count.
9799
*
98100
* @param res Pointer to allocated array to store discovered APs.
99101
* @param count Size of allocated res array, or 0 to only count available APs.
100-
* @return Number of entries in res, or if count was 0 number of available networks.
102+
* @return Number of entries in res, or if count was 0, number of available networks.
101103
* Negative on error (@see nsapi_types.h for nsapi_error).
102104
*/
103105
virtual nsapi_size_or_error_t scan(WiFiAccessPoint *res, nsapi_size_t count) = 0;

0 commit comments

Comments
 (0)