Skip to content

Commit db15c1a

Browse files
committed
WiFi: Minor fixes to docs and includes
1 parent 7963e8e commit db15c1a

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

features/netsocket/WiFiInterface.h

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
#define WIFI_INTERFACE_H
2222

2323
#include <string.h>
24-
#include "Callback.h"
2524
#include "netsocket/NetworkInterface.h"
2625
#include "netsocket/WiFiAccessPoint.h"
2726

@@ -91,17 +90,14 @@ class WiFiInterface: public NetworkInterface
9190

9291
/** Scan for available networks
9392
*
94-
* The scan will
95-
* If the network interface is set to non-blocking mode, scan will attempt to scan
96-
* for WiFi networks asynchronously and return NSAPI_ERROR_WOULD_BLOCK. If a callback
97-
* is attached, the callback will be called when the operation has completed.
93+
* This function will block. If the @a count is 0, function will only return count of available networks, so that
94+
* user can allocated necessary memory. If the @count is grater than 0 and the @a ap is not NULL it'll be populated
95+
* with discovered networks up to value of @a count.
9896
*
99-
* @param ap Pointer to allocated array to store discovered AP
100-
* @param count Size of allocated @a res array, or 0 to only count available AP
101-
* @param timeout Timeout in milliseconds; 0 for no timeout (Default: 0)
102-
* @return Number of entries in @a, or if @a count was 0 number of available networks,
103-
* negative on error
104-
* see @a nsapi_error
97+
* @param ap Pointer to allocated array to store discovered AP
98+
* @param count Size of allocated @a res array, or 0 to only count available AP
99+
* @return Number of entries in @a, or if @a count was 0 number of available networks,
100+
* negative on error see @a nsapi_error
105101
*/
106102
virtual nsapi_size_or_error_t scan(WiFiAccessPoint *res, nsapi_size_t count) = 0;
107103
};

0 commit comments

Comments
 (0)