Skip to content

Commit 90e08ca

Browse files
author
Jarno Lamsa
committed
WifiInterface doxygen cleanup
1 parent c27dabe commit 90e08ca

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

features/netsocket/WiFiInterface.h

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11

2+
/** \addtogroup netsocket */
3+
/** @{*/
24
/* WiFiInterface
35
* Copyright (c) 2015 - 2016 ARM Limited
46
*
@@ -23,8 +25,6 @@
2325
#include "netsocket/WiFiAccessPoint.h"
2426

2527
/** Common interface that is shared between Wi-Fi devices.
26-
*
27-
* @addtogroup netsocket
2828
*/
2929
class WiFiInterface: public virtual NetworkInterface {
3030
public:
@@ -89,13 +89,15 @@ class WiFiInterface: public virtual NetworkInterface {
8989

9090
/** Scan for available networks.
9191
*
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.
9597
*
9698
* @param res Pointer to allocated array to store discovered APs.
9799
* @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.
99101
* Negative on error (@see nsapi_types.h for nsapi_error).
100102
*/
101103
virtual nsapi_size_or_error_t scan(WiFiAccessPoint *res, nsapi_size_t count) = 0;

0 commit comments

Comments
 (0)