Skip to content

Commit 249fa7f

Browse files
author
Seppo Takalo
committed
Create new netinterface Doxygen group
1 parent 604a6ea commit 249fa7f

File tree

7 files changed

+29
-22
lines changed

7 files changed

+29
-22
lines changed

features/netsocket/CellularBase.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
/* @file CellularBase.h CellularBase */
1717

18-
/** @addtogroup netsocket
18+
/** @addtogroup netinterface
1919
* @{
2020
*/
2121

features/netsocket/DNS.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,14 @@
1414
* limitations under the License.
1515
*/
1616

17+
/** @file DNS.h Domain Name Service */
18+
/** @\addtogroup netsocket
19+
* @{ */
20+
1721
#ifndef DNS_H
1822
#define DNS_H
1923

24+
/** Base class for DNS provider */
2025
class DNS {
2126
public:
2227

features/netsocket/EthInterface.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-
/* EthInterface
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 EthInterface.h Common interface that is ahared between Ethernet hardware */
18+
/** \addtogroup netinterface */
19+
/** @{*/
20+
2021
#ifndef ETH_INTERFACE_H
2122
#define ETH_INTERFACE_H
2223

features/netsocket/MeshInterface.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-
/* MeshInterface
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 MeshInterface.h Mesh network interface */
18+
/** \addtogroup netinterface */
19+
/** @{*/
20+
2021
#ifndef MESH_INTERFACE_H
2122
#define MESH_INTERFACE_H
2223

features/netsocket/NetworkInterface.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
*/
1616

1717
/** @file NetworkInterface.h Network Interface base class */
18-
/** @\addtogroup netsocket
18+
/** @addtogroup netinterface
19+
* Network Interface classes
1920
* @{ */
2021

2122

features/netsocket/WiFiInterface.h

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

17+
/** @file WifiInterface.h Common interface that is shared between Wi-Fi devices */
18+
/** @addtogroup netinterface
19+
* @{
20+
*/
21+
1822
#ifndef WIFI_INTERFACE_H
1923
#define WIFI_INTERFACE_H
2024

2125
#include <string.h>
2226
#include "netsocket/NetworkInterface.h"
2327
#include "netsocket/WiFiAccessPoint.h"
2428

25-
/** @file WifiInterface.h Common interface that is shared between Wi-Fi devices */
26-
/** @addtogroup netsocket
27-
* @{
28-
*/
29-
3029
/** Common interface that is shared between Wi-Fi devices.
31-
*
3230
*/
3331
class WiFiInterface: public virtual NetworkInterface {
3432
public:

features/netsocket/nsapi_dns.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-
/* nsapi_dns.h
1+
/*
52
* Original work Copyright (c) 2013 Henry Leinen (henry[dot]leinen [at] online [dot] de)
63
* Modified work Copyright (c) 2015 ARM Limited
74
*
@@ -17,6 +14,10 @@
1714
* See the License for the specific language governing permissions and
1815
* limitations under the License.
1916
*/
17+
18+
/** \addtogroup netsocket */
19+
/** @{*/
20+
2021
#ifndef NSAPI_DNS_H
2122
#define NSAPI_DNS_H
2223

0 commit comments

Comments
 (0)