diff --git a/features/netsocket/CellularBase.h b/features/netsocket/CellularBase.h index 1d306cc316..929771e8b2 100644 --- a/features/netsocket/CellularBase.h +++ b/features/netsocket/CellularBase.h @@ -13,13 +13,18 @@ * limitations under the License. */ +/* @file CellularBase.h CellularBase */ + +/** @addtogroup netsocket + * @{ + */ + #ifndef CELLULAR_BASE_H #define CELLULAR_BASE_H #include "netsocket/NetworkInterface.h" /** Common interface that is shared between cellular interfaces. - * @addtogroup netsocket */ class CellularBase: public NetworkInterface { diff --git a/features/netsocket/NetworkStack.h b/features/netsocket/NetworkStack.h index 8edb9e0645..64fac20449 100644 --- a/features/netsocket/NetworkStack.h +++ b/features/netsocket/NetworkStack.h @@ -23,6 +23,10 @@ #include "netsocket/NetworkInterface.h" #include "DNS.h" +/** @file NetworkStack.h NetworkStack class */ +/** @addtogroup netsocket + * @{ */ + // Predeclared classes class OnboardNetworkStack; @@ -32,7 +36,6 @@ class OnboardNetworkStack; * can connect to a network over IP. By implementing the * NetworkStack, a network stack can be used as a target * for instantiating network sockets. - * @addtogroup netsocket */ class NetworkStack: public DNS { public: @@ -421,3 +424,5 @@ NetworkStack *nsapi_create_stack(IF *iface) #endif + +/** @} */ diff --git a/features/netsocket/Socket.h b/features/netsocket/Socket.h index a9f4c0788e..1906b034ef 100644 --- a/features/netsocket/Socket.h +++ b/features/netsocket/Socket.h @@ -1,7 +1,4 @@ - -/** \addtogroup netsocket */ -/** @{*/ -/* Socket +/* * Copyright (c) 2015 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -17,6 +14,11 @@ * limitations under the License. */ +/** @file Socket.h Abstract Socket interface */ +/** @addtogroup netsocket + * Mbed OS Socket API + * @{ */ + #ifndef SOCKET_H #define SOCKET_H diff --git a/features/netsocket/SocketAddress.h b/features/netsocket/SocketAddress.h index b4b68c1a9d..70997ab95c 100644 --- a/features/netsocket/SocketAddress.h +++ b/features/netsocket/SocketAddress.h @@ -1,5 +1,4 @@ - -/* SocketAddress +/* * Copyright (c) 2015 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -15,6 +14,10 @@ * limitations under the License. */ +/** @file SocketAddress.h SocketAddress class */ +/** \addtogroup netsocket + * @{*/ + #ifndef SOCKET_ADDRESS_H #define SOCKET_ADDRESS_H @@ -29,7 +32,6 @@ class NetworkInterface; /** SocketAddress class * * Representation of an IP address and port pair. - * @addtogroup netsocket */ class SocketAddress { public: diff --git a/features/netsocket/TCPServer.h b/features/netsocket/TCPServer.h index 721e5de443..3a0a5c3c4e 100644 --- a/features/netsocket/TCPServer.h +++ b/features/netsocket/TCPServer.h @@ -1,5 +1,4 @@ - -/* TCPServer +/* * Copyright (c) 2015 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -15,6 +14,10 @@ * limitations under the License. */ +/** @file TCPServer.h Deprecated TCPServer class */ +/** \addtogroup netsocket + * @{*/ + #ifndef TCPSERVER_H #define TCPSERVER_H @@ -26,7 +29,6 @@ /** TCP socket server - * @addtogroup netsocket */ class TCPServer : public TCPSocket { public: @@ -82,3 +84,5 @@ public: }; #endif + +/** @} */ diff --git a/features/netsocket/TCPSocket.h b/features/netsocket/TCPSocket.h index c52a5fc094..4acddce8ce 100644 --- a/features/netsocket/TCPSocket.h +++ b/features/netsocket/TCPSocket.h @@ -1,7 +1,4 @@ - -/** \addtogroup netsocket */ -/** @{*/ -/* TCPSocket +/* * Copyright (c) 2015 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -17,6 +14,10 @@ * limitations under the License. */ +/** @file TCPSocket.h TCPSocket class */ +/** \addtogroup netsocket + * @{*/ + #ifndef TCPSOCKET_H #define TCPSOCKET_H diff --git a/features/netsocket/WiFiInterface.h b/features/netsocket/WiFiInterface.h index fd2266c882..f9d85cbcbf 100644 --- a/features/netsocket/WiFiInterface.h +++ b/features/netsocket/WiFiInterface.h @@ -22,9 +22,13 @@ #include "netsocket/NetworkInterface.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. * - * @addtogroup netsocket */ class WiFiInterface: public virtual NetworkInterface { public: