ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Remove doxygen warnings in nsapi

pull/4425/head
Jimmy Brisson 2017-06-01 16:43:43 -05:00 committed by Sam Grove
parent a09db78a4c
commit aabecf633b
8 changed files with 38 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
features/netsocket/CellularInterface.h
View File

@ -1,5 +1,3 @@
/** \addtogroup netsocket */
/** @{*/
/* CellularInterface /* CellularInterface
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -25,6 +23,7 @@
/** CellularInterface class /** CellularInterface class
* *
* Common interface that is shared between ethernet hardware * Common interface that is shared between ethernet hardware
* @addtogroup netsocket
*/ */
class CellularInterface : public NetworkInterface class CellularInterface : public NetworkInterface
{ {
@ -36,8 +35,8 @@ public:
/** Set the cellular network APN and credentials /** Set the cellular network APN and credentials
* *
* @param apn Optional name of the network to connect to * @param apn Optional name of the network to connect to
* @param user Optional username for the APN * @param username Optional username for the APN
* @param pass Optional password fot the APN * @param password Optional password fot the APN
* @return 0 on success, negative error code on failure * @return 0 on success, negative error code on failure
*/ */
virtual nsapi_error_t set_credentials(const char *apn, virtual nsapi_error_t set_credentials(const char *apn,
@ -70,5 +69,3 @@ public:
#endif #endif
/** @}*/

10
features/netsocket/NetworkInterface.h
View File

@ -1,6 +1,3 @@
/** \addtogroup netsocket */
/** @{*/
/* NetworkStack /* NetworkStack
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -30,6 +27,7 @@ class NetworkStack;
/** NetworkInterface class /** NetworkInterface class
* *
* Common interface that is shared between network devices * Common interface that is shared between network devices
* @addtogroup netsocket
*/ */
class NetworkInterface { class NetworkInterface {
public: public:
@ -73,7 +71,7 @@ public:
* Implicitly disables DHCP, which can be enabled in set_dhcp. * Implicitly disables DHCP, which can be enabled in set_dhcp.
* Requires that the network is disconnected. * Requires that the network is disconnected.
* *
* @param address Null-terminated representation of the local IP address * @param ip_address Null-terminated representation of the local IP address
* @param netmask Null-terminated representation of the local network mask * @param netmask Null-terminated representation of the local network mask
* @param gateway Null-terminated representation of the local gateway * @param gateway Null-terminated representation of the local gateway
* @return 0 on success, negative error code on failure * @return 0 on success, negative error code on failure
@ -123,7 +121,7 @@ public:
/** Add a domain name server to list of servers to query /** Add a domain name server to list of servers to query
* *
* @param addr Destination for the host address * @param address Destination for the host address
* @return 0 on success, negative error code on failure * @return 0 on success, negative error code on failure
*/ */
virtual nsapi_error_t add_dns_server(const SocketAddress &address); virtual nsapi_error_t add_dns_server(const SocketAddress &address);
@ -146,5 +144,3 @@ protected:
#endif #endif
/** @}*/

9
features/netsocket/NetworkStack.h
View File

@ -1,6 +1,4 @@
/** \addtogroup netsocket */
/** @{*/
/* NetworkStack /* NetworkStack
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -31,6 +29,7 @@
* can connect to a network over IP. By implementing the * can connect to a network over IP. By implementing the
* NetworkStack, a network stack can be used as a target * NetworkStack, a network stack can be used as a target
* for instantiating network sockets. * for instantiating network sockets.
* @addtogroup netsocket
*/ */
class NetworkStack class NetworkStack
{ {
@ -63,7 +62,7 @@ public:
/** Add a domain name server to list of servers to query /** Add a domain name server to list of servers to query
* *
* @param addr Destination for the host address * @param address Destination for the host address
* @return 0 on success, negative error code on failure * @return 0 on success, negative error code on failure
*/ */
virtual nsapi_error_t add_dns_server(const SocketAddress &address); virtual nsapi_error_t add_dns_server(const SocketAddress &address);
@ -246,7 +245,7 @@ protected:
* *
* @param handle Socket handle * @param handle Socket handle
* @param address Destination for the source address or NULL * @param address Destination for the source address or NULL
* @param data Destination buffer for data received from the host * @param buffer Destination buffer for data received from the host
* @param size Size of the buffer in bytes * @param size Size of the buffer in bytes
* @return Number of received bytes on success, negative error * @return Number of received bytes on success, negative error
* code on failure * code on failure
@ -322,5 +321,3 @@ NetworkStack *nsapi_create_stack(IF *iface)
#endif #endif
/** @}*/

7
features/netsocket/SocketAddress.h
View File

@ -1,6 +1,4 @@
/** \addtogroup netsocket */
/** @{*/
/* SocketAddress /* SocketAddress
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -31,6 +29,7 @@ class NetworkInterface;
/** SocketAddress class /** SocketAddress class
* *
* Representation of an IP address and port pair. * Representation of an IP address and port pair.
* @addtogroup netsocket
*/ */
class SocketAddress { class SocketAddress {
public: public:
@ -66,7 +65,7 @@ public:
/** Create a SocketAddress from an IP address and port /** Create a SocketAddress from an IP address and port
* *
* @param host Null-terminated representation of the IP address * @param addr Null-terminated representation of the IP address
* @param port Optional 16-bit port * @param port Optional 16-bit port
*/ */
SocketAddress(const char *addr, uint16_t port = 0); SocketAddress(const char *addr, uint16_t port = 0);
@ -81,7 +80,7 @@ public:
/** Create a SocketAddress from another SocketAddress /** Create a SocketAddress from another SocketAddress
* *
* @param address SocketAddress to copy * @param addr SocketAddress to copy
*/ */
SocketAddress(const SocketAddress &addr); SocketAddress(const SocketAddress &addr);

7
features/netsocket/TCPServer.h
View File

@ -1,6 +1,4 @@
/** \addtogroup netsocket */
/** @{*/
/* TCPServer /* TCPServer
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -28,6 +26,7 @@
/** TCP socket server /** TCP socket server
* @addtogroup netsocket
*/ */
class TCPServer : public Socket { class TCPServer : public Socket {
public: public:
@ -78,7 +77,7 @@ public:
* non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned * non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
* immediately. * immediately.
* *
* @param socket TCPSocket instance that will handle the incoming connection. * @param connection TCPSocket instance that will handle the incoming connection.
* @param address Destination for the remote address or NULL * @param address Destination for the remote address or NULL
* @return 0 on success, negative error code on failure * @return 0 on success, negative error code on failure
*/ */
@ -94,5 +93,3 @@ protected:
#endif #endif
/** @}*/

11
features/netsocket/WiFiInterface.h
View File

@ -1,6 +1,4 @@
/** \addtogroup netsocket */
/** @{*/
/* WiFiInterface /* WiFiInterface
* Copyright (c) 2015 - 2016 ARM Limited * Copyright (c) 2015 - 2016 ARM Limited
* *
@ -27,6 +25,7 @@
/** WiFiInterface class /** WiFiInterface class
* *
* Common interface that is shared between WiFi devices * Common interface that is shared between WiFi devices
* @addtogroup netsocket
*/ */
class WiFiInterface: public NetworkInterface class WiFiInterface: public NetworkInterface
{ {
@ -91,12 +90,12 @@ public:
/** Scan for available networks /** Scan for available networks
* *
* This function will block. If the @a count is 0, function will only return count of available networks, so that * This function will block. If the @a 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 ap is not NULL it'll be populated * user can allocated necessary memory. If the \p count is grater than 0 and the a \p res is not NULL it'll be populated
* with discovered networks up to value of @a count. * with discovered networks up to value of \p count.
* *
* @param ap Pointer to allocated array to store discovered AP * @param res Pointer to allocated array to store discovered AP
* @param count Size of allocated @a res array, or 0 to only count available AP * @param count Size of allocated @a res array, or 0 to only count available AP
* @return Number of entries in @a, or if @a count was 0 number of available networks, * @return Number of entries in \p count, or if \p count was 0 number of available networks,
* negative on error see @a nsapi_error * negative on error see @a nsapi_error
*/ */
virtual nsapi_size_or_error_t scan(WiFiAccessPoint *res, nsapi_size_t count) = 0; virtual nsapi_size_or_error_t scan(WiFiAccessPoint *res, nsapi_size_t count) = 0;

2
features/netsocket/nsapi_ppp.h
View File

@ -83,4 +83,6 @@ const char *nsapi_ppp_get_gw_addr(FileHandle *stream);
} //namespace mbed } //namespace mbed
/** @} */
#endif /* NSAPI_PPP_H_ */ #endif /* NSAPI_PPP_H_ */

22
features/netsocket/nsapi_types.h
View File

@ -32,7 +32,7 @@ extern "C" {
* Valid error codes have negative values and may * Valid error codes have negative values and may
* be returned by any network operation. * be returned by any network operation.
* *
* @enum nsapi_error_t * @enum nsapi_error
*/ */
enum nsapi_error { enum nsapi_error {
NSAPI_ERROR_OK = 0, /*!< no error */ NSAPI_ERROR_OK = 0, /*!< no error */
@ -125,7 +125,7 @@ typedef enum nsapi_security {
* *
* The IP version specifies the type of an IP address. * The IP version specifies the type of an IP address.
* *
* @enum nsapi_version_t * @enum nsapi_version
*/ */
typedef enum nsapi_version { typedef enum nsapi_version {
NSAPI_UNSPEC, /*!< Address is unspecified */ NSAPI_UNSPEC, /*!< Address is unspecified */
@ -160,51 +160,51 @@ typedef void *nsapi_socket_t;
* The socket protocol specifies a particular protocol to * The socket protocol specifies a particular protocol to
* be used with a newly created socket. * be used with a newly created socket.
* *
* @enum nsapi_protocol_t * @enum nsapi_protocol
*/ */
typedef enum nsapi_protocol { typedef enum nsapi_protocol {
NSAPI_TCP, /*!< Socket is of TCP type */ NSAPI_TCP, /*!< Socket is of TCP type */
NSAPI_UDP, /*!< Socket is of UDP type */ NSAPI_UDP, /*!< Socket is of UDP type */
} nsapi_protocol_t; } nsapi_protocol_t;
/* Enum of standardized stack option levels /** Enum of standardized stack option levels
* for use with NetworkStack::setstackopt and getstackopt. * for use with NetworkStack::setstackopt and getstackopt.
* *
* @enum nsapi_stack_level_t * @enum nsapi_stack_level
*/ */
typedef enum nsapi_stack_level { typedef enum nsapi_stack_level {
NSAPI_STACK = 5000, /*!< Stack option level - see nsapi_stack_option_t for options */ NSAPI_STACK = 5000, /*!< Stack option level - see nsapi_stack_option_t for options */
} nsapi_stack_level_t; } nsapi_stack_level_t;
/* Enum of standardized stack option names for level NSAPI_STACK /** Enum of standardized stack option names for level NSAPI_STACK
* of NetworkStack::setstackopt and getstackopt. * of NetworkStack::setstackopt and getstackopt.
* *
* These options may not be supported on all stacks, in which * These options may not be supported on all stacks, in which
* case NSAPI_ERROR_UNSUPPORTED may be returned. * case NSAPI_ERROR_UNSUPPORTED may be returned.
* *
* @enum nsapi_stack_option_t * @enum nsapi_stack_option
*/ */
typedef enum nsapi_stack_option { typedef enum nsapi_stack_option {
NSAPI_IPV4_MRU, /*!< Sets/gets size of largest IPv4 fragmented datagram to reassemble */ NSAPI_IPV4_MRU, /*!< Sets/gets size of largest IPv4 fragmented datagram to reassemble */
NSAPI_IPV6_MRU, /*!< Sets/gets size of largest IPv6 fragmented datagram to reassemble */ NSAPI_IPV6_MRU, /*!< Sets/gets size of largest IPv6 fragmented datagram to reassemble */
} nsapi_stack_option_t; } nsapi_stack_option_t;
/* Enum of standardized socket option levels /** Enum of standardized socket option levels
* for use with Socket::setsockopt and getsockopt. * for use with Socket::setsockopt and getsockopt.
* *
* @enum nsapi_socket_level_t * @enum nsapi_socket_level
*/ */
typedef enum nsapi_socket_level { typedef enum nsapi_socket_level {
NSAPI_SOCKET = 7000, /*!< Socket option level - see nsapi_socket_option_t for options */ NSAPI_SOCKET = 7000, /*!< Socket option level - see nsapi_socket_option_t for options */
} nsapi_socket_level_t; } nsapi_socket_level_t;
/* Enum of standardized socket option names for level NSAPI_SOCKET /** Enum of standardized socket option names for level NSAPI_SOCKET
* of Socket::setsockopt and getsockopt. * of Socket::setsockopt and getsockopt.
* *
* These options may not be supported on all stacks, in which * These options may not be supported on all stacks, in which
* case NSAPI_ERROR_UNSUPPORTED may be returned. * case NSAPI_ERROR_UNSUPPORTED may be returned.
* *
* @enum nsapi_socket_option_t * @enum nsapi_socket_option
*/ */
typedef enum nsapi_socket_option { typedef enum nsapi_socket_option {
NSAPI_REUSEADDR, /*!< Allow bind to reuse local addresses */ NSAPI_REUSEADDR, /*!< Allow bind to reuse local addresses */