mirror of https://github.com/ARMmbed/mbed-os.git
Fix netsocket Doxygen group
parent
8f48104842
commit
bfd497fe26
|
@ -13,13 +13,18 @@
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/* @file CellularBase.h CellularBase */
|
||||||
|
|
||||||
|
/** @addtogroup netsocket
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
#ifndef CELLULAR_BASE_H
|
#ifndef CELLULAR_BASE_H
|
||||||
#define CELLULAR_BASE_H
|
#define CELLULAR_BASE_H
|
||||||
|
|
||||||
#include "netsocket/NetworkInterface.h"
|
#include "netsocket/NetworkInterface.h"
|
||||||
|
|
||||||
/** Common interface that is shared between cellular interfaces.
|
/** Common interface that is shared between cellular interfaces.
|
||||||
* @addtogroup netsocket
|
|
||||||
*/
|
*/
|
||||||
class CellularBase: public NetworkInterface {
|
class CellularBase: public NetworkInterface {
|
||||||
|
|
||||||
|
|
|
@ -23,6 +23,10 @@
|
||||||
#include "netsocket/NetworkInterface.h"
|
#include "netsocket/NetworkInterface.h"
|
||||||
#include "DNS.h"
|
#include "DNS.h"
|
||||||
|
|
||||||
|
/** @file NetworkStack.h NetworkStack class */
|
||||||
|
/** @addtogroup netsocket
|
||||||
|
* @{ */
|
||||||
|
|
||||||
// Predeclared classes
|
// Predeclared classes
|
||||||
class OnboardNetworkStack;
|
class OnboardNetworkStack;
|
||||||
|
|
||||||
|
@ -32,7 +36,6 @@ class OnboardNetworkStack;
|
||||||
* 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: public DNS {
|
class NetworkStack: public DNS {
|
||||||
public:
|
public:
|
||||||
|
@ -421,3 +424,5 @@ NetworkStack *nsapi_create_stack(IF *iface)
|
||||||
|
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/** @} */
|
||||||
|
|
|
@ -1,7 +1,4 @@
|
||||||
|
/*
|
||||||
/** \addtogroup netsocket */
|
|
||||||
/** @{*/
|
|
||||||
/* Socket
|
|
||||||
* Copyright (c) 2015 ARM Limited
|
* Copyright (c) 2015 ARM Limited
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@ -17,6 +14,11 @@
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/** @file Socket.h Abstract Socket interface */
|
||||||
|
/** @addtogroup netsocket
|
||||||
|
* Mbed OS Socket API
|
||||||
|
* @{ */
|
||||||
|
|
||||||
#ifndef SOCKET_H
|
#ifndef SOCKET_H
|
||||||
#define SOCKET_H
|
#define SOCKET_H
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,4 @@
|
||||||
|
/*
|
||||||
/* SocketAddress
|
|
||||||
* Copyright (c) 2015 ARM Limited
|
* Copyright (c) 2015 ARM Limited
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@ -15,6 +14,10 @@
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/** @file SocketAddress.h SocketAddress class */
|
||||||
|
/** \addtogroup netsocket
|
||||||
|
* @{*/
|
||||||
|
|
||||||
#ifndef SOCKET_ADDRESS_H
|
#ifndef SOCKET_ADDRESS_H
|
||||||
#define SOCKET_ADDRESS_H
|
#define SOCKET_ADDRESS_H
|
||||||
|
|
||||||
|
@ -29,7 +32,6 @@ 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:
|
||||||
|
|
|
@ -1,5 +1,4 @@
|
||||||
|
/*
|
||||||
/* TCPServer
|
|
||||||
* Copyright (c) 2015 ARM Limited
|
* Copyright (c) 2015 ARM Limited
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@ -15,6 +14,10 @@
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/** @file TCPServer.h Deprecated TCPServer class */
|
||||||
|
/** \addtogroup netsocket
|
||||||
|
* @{*/
|
||||||
|
|
||||||
#ifndef TCPSERVER_H
|
#ifndef TCPSERVER_H
|
||||||
#define TCPSERVER_H
|
#define TCPSERVER_H
|
||||||
|
|
||||||
|
@ -26,7 +29,6 @@
|
||||||
|
|
||||||
|
|
||||||
/** TCP socket server
|
/** TCP socket server
|
||||||
* @addtogroup netsocket
|
|
||||||
*/
|
*/
|
||||||
class TCPServer : public TCPSocket {
|
class TCPServer : public TCPSocket {
|
||||||
public:
|
public:
|
||||||
|
@ -82,3 +84,5 @@ public:
|
||||||
};
|
};
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/** @} */
|
||||||
|
|
|
@ -1,7 +1,4 @@
|
||||||
|
/*
|
||||||
/** \addtogroup netsocket */
|
|
||||||
/** @{*/
|
|
||||||
/* TCPSocket
|
|
||||||
* Copyright (c) 2015 ARM Limited
|
* Copyright (c) 2015 ARM Limited
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@ -17,6 +14,10 @@
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/** @file TCPSocket.h TCPSocket class */
|
||||||
|
/** \addtogroup netsocket
|
||||||
|
* @{*/
|
||||||
|
|
||||||
#ifndef TCPSOCKET_H
|
#ifndef TCPSOCKET_H
|
||||||
#define TCPSOCKET_H
|
#define TCPSOCKET_H
|
||||||
|
|
||||||
|
|
|
@ -22,9 +22,13 @@
|
||||||
#include "netsocket/NetworkInterface.h"
|
#include "netsocket/NetworkInterface.h"
|
||||||
#include "netsocket/WiFiAccessPoint.h"
|
#include "netsocket/WiFiAccessPoint.h"
|
||||||
|
|
||||||
|
/** @file WifiInterface.h Common interface that is shared between Wi-Fi devices */
|
||||||
|
/** @addtogroup netsocket
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
/** Common interface that is shared between Wi-Fi devices.
|
/** Common interface that is shared between Wi-Fi devices.
|
||||||
*
|
*
|
||||||
* @addtogroup netsocket
|
|
||||||
*/
|
*/
|
||||||
class WiFiInterface: public virtual NetworkInterface {
|
class WiFiInterface: public virtual NetworkInterface {
|
||||||
public:
|
public:
|
||||||
|
|
Loading…
Reference in New Issue