|
1 | 1 |
|
| 2 | +/** \addtogroup netsocket */ |
| 3 | +/** @{*/ |
2 | 4 | /* WiFiInterface |
3 | 5 | * Copyright (c) 2015 - 2016 ARM Limited |
4 | 6 | * |
|
23 | 25 | #include "netsocket/WiFiAccessPoint.h" |
24 | 26 |
|
25 | 27 | /** Common interface that is shared between Wi-Fi devices. |
26 | | - * |
27 | | - * @addtogroup netsocket |
28 | 28 | */ |
29 | 29 | class WiFiInterface: public virtual NetworkInterface { |
30 | 30 | public: |
@@ -89,13 +89,15 @@ class WiFiInterface: public virtual NetworkInterface { |
89 | 89 |
|
90 | 90 | /** Scan for available networks. |
91 | 91 | * |
92 | | - * This function will block. If the count is 0, function will only return count of available networks, so that |
93 | | - * user can allocated necessary memory. If the count is grater than 0 and the a \p res is not NULL it'll be populated |
94 | | - * with discovered networks up to value of count. |
| 92 | + * @note This is a blocking function. |
| 93 | + * |
| 94 | + * If the \p count is 0, the function only returns the number of available networks. |
| 95 | + * If the \p count is greater than 0 and the \p res is not NULL, the array of discovered APs is populated |
| 96 | + * with discovered networks up to the value of the \p count. |
95 | 97 | * |
96 | 98 | * @param res Pointer to allocated array to store discovered APs. |
97 | 99 | * @param count Size of allocated res array, or 0 to only count available APs. |
98 | | - * @return Number of entries in res, or if count was 0 number of available networks. |
| 100 | + * @return Number of entries in res, or if count was 0, number of available networks. |
99 | 101 | * Negative on error (@see nsapi_types.h for nsapi_error). |
100 | 102 | */ |
101 | 103 | virtual nsapi_size_or_error_t scan(WiFiAccessPoint *res, nsapi_size_t count) = 0; |
|
0 commit comments