File tree Expand file tree Collapse file tree 1 file changed +6
-4
lines changed Expand file tree Collapse file tree 1 file changed +6
-4
lines changed Original file line number Diff line number Diff line change @@ -91,13 +91,15 @@ class WiFiInterface: public virtual NetworkInterface {
91
91
92
92
/* * Scan for available networks.
93
93
*
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.
97
99
*
98
100
* @param res Pointer to allocated array to store discovered APs.
99
101
* @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.
101
103
* Negative on error (@see nsapi_types.h for nsapi_error).
102
104
*/
103
105
virtual nsapi_size_or_error_t scan (WiFiAccessPoint *res, nsapi_size_t count) = 0;
You can’t perform that action at this time.
0 commit comments