Skip to content

Commit bfd497f

Browse files
author
Seppo Takalo
committed
Fix netsocket Doxygen group
1 parent 8f48104 commit bfd497f

File tree

7 files changed

+40
-17
lines changed

7 files changed

+40
-17
lines changed

features/netsocket/CellularBase.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,18 @@
1313
* limitations under the License.
1414
*/
1515

16+
/* @file CellularBase.h CellularBase */
17+
18+
/** @addtogroup netsocket
19+
* @{
20+
*/
21+
1622
#ifndef CELLULAR_BASE_H
1723
#define CELLULAR_BASE_H
1824

1925
#include "netsocket/NetworkInterface.h"
2026

2127
/** Common interface that is shared between cellular interfaces.
22-
* @addtogroup netsocket
2328
*/
2429
class CellularBase: public NetworkInterface {
2530

features/netsocket/NetworkStack.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@
2323
#include "netsocket/NetworkInterface.h"
2424
#include "DNS.h"
2525

26+
/** @file NetworkStack.h NetworkStack class */
27+
/** @addtogroup netsocket
28+
* @{ */
29+
2630
// Predeclared classes
2731
class OnboardNetworkStack;
2832

@@ -32,7 +36,6 @@ class OnboardNetworkStack;
3236
* can connect to a network over IP. By implementing the
3337
* NetworkStack, a network stack can be used as a target
3438
* for instantiating network sockets.
35-
* @addtogroup netsocket
3639
*/
3740
class NetworkStack: public DNS {
3841
public:
@@ -421,3 +424,5 @@ NetworkStack *nsapi_create_stack(IF *iface)
421424

422425

423426
#endif
427+
428+
/** @} */

features/netsocket/Socket.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
2-
/** \addtogroup netsocket */
3-
/** @{*/
4-
/* Socket
1+
/*
52
* Copyright (c) 2015 ARM Limited
63
*
74
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,6 +14,11 @@
1714
* limitations under the License.
1815
*/
1916

17+
/** @file Socket.h Abstract Socket interface */
18+
/** @addtogroup netsocket
19+
* Mbed OS Socket API
20+
* @{ */
21+
2022
#ifndef SOCKET_H
2123
#define SOCKET_H
2224

features/netsocket/SocketAddress.h

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
2-
/* SocketAddress
1+
/*
32
* Copyright (c) 2015 ARM Limited
43
*
54
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,6 +14,10 @@
1514
* limitations under the License.
1615
*/
1716

17+
/** @file SocketAddress.h SocketAddress class */
18+
/** \addtogroup netsocket
19+
* @{*/
20+
1821
#ifndef SOCKET_ADDRESS_H
1922
#define SOCKET_ADDRESS_H
2023

@@ -29,7 +32,6 @@ class NetworkInterface;
2932
/** SocketAddress class
3033
*
3134
* Representation of an IP address and port pair.
32-
* @addtogroup netsocket
3335
*/
3436
class SocketAddress {
3537
public:

features/netsocket/TCPServer.h

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
2-
/* TCPServer
1+
/*
32
* Copyright (c) 2015 ARM Limited
43
*
54
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,6 +14,10 @@
1514
* limitations under the License.
1615
*/
1716

17+
/** @file TCPServer.h Deprecated TCPServer class */
18+
/** \addtogroup netsocket
19+
* @{*/
20+
1821
#ifndef TCPSERVER_H
1922
#define TCPSERVER_H
2023

@@ -26,7 +29,6 @@
2629

2730

2831
/** TCP socket server
29-
* @addtogroup netsocket
3032
*/
3133
class TCPServer : public TCPSocket {
3234
public:
@@ -82,3 +84,5 @@ class TCPServer : public TCPSocket {
8284
};
8385

8486
#endif
87+
88+
/** @} */

features/netsocket/TCPSocket.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
2-
/** \addtogroup netsocket */
3-
/** @{*/
4-
/* TCPSocket
1+
/*
52
* Copyright (c) 2015 ARM Limited
63
*
74
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,6 +14,10 @@
1714
* limitations under the License.
1815
*/
1916

17+
/** @file TCPSocket.h TCPSocket class */
18+
/** \addtogroup netsocket
19+
* @{*/
20+
2021
#ifndef TCPSOCKET_H
2122
#define TCPSOCKET_H
2223

features/netsocket/WiFiInterface.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,13 @@
2222
#include "netsocket/NetworkInterface.h"
2323
#include "netsocket/WiFiAccessPoint.h"
2424

25+
/** @file WifiInterface.h Common interface that is shared between Wi-Fi devices */
26+
/** @addtogroup netsocket
27+
* @{
28+
*/
29+
2530
/** Common interface that is shared between Wi-Fi devices.
2631
*
27-
* @addtogroup netsocket
2832
*/
2933
class WiFiInterface: public virtual NetworkInterface {
3034
public:

0 commit comments

Comments
 (0)