Skip to content

WifiInterface doxygen cleanup #9301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

WifiInterface doxygen cleanup #9301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions features/netsocket/WiFiInterface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

/** \addtogroup netsocket */
/** @{*/
/* WiFiInterface
* Copyright (c) 2015 - 2016 ARM Limited
*
Expand All @@ -23,8 +25,6 @@
#include "netsocket/WiFiAccessPoint.h"

/** Common interface that is shared between Wi-Fi devices.
*
* @addtogroup netsocket
*/
class WiFiInterface: public virtual NetworkInterface {
public:
Expand Down Expand Up @@ -89,13 +89,15 @@ class WiFiInterface: public virtual NetworkInterface {

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