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

Create new netinterface Doxygen group

pull/9328/head
Seppo Takalo 2019-01-09 15:20:22 +02:00
parent 604a6ea5e0
commit 249fa7fd6f
7 changed files with 29 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
features/netsocket/CellularBase.h
View File

@ -15,7 +15,7 @@
/* @file CellularBase.h CellularBase */ /* @file CellularBase.h CellularBase */
/** @addtogroup netsocket /** @addtogroup netinterface
* @{ * @{
*/ */

5
features/netsocket/DNS.h
View File

@ -14,9 +14,14 @@
* limitations under the License. * limitations under the License.
*/ */
/** @file DNS.h Domain Name Service */
/** @\addtogroup netsocket
* @{ */
#ifndef DNS_H #ifndef DNS_H
#define DNS_H #define DNS_H
/** Base class for DNS provider */
class DNS { class DNS {
public: public:

9
features/netsocket/EthInterface.h
View File

@ -1,7 +1,4 @@
/*
/** \addtogroup netsocket */
/** @{*/
/* EthInterface
* 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 EthInterface.h Common interface that is ahared between Ethernet hardware */
/** \addtogroup netinterface */
/** @{*/
#ifndef ETH_INTERFACE_H #ifndef ETH_INTERFACE_H
#define ETH_INTERFACE_H #define ETH_INTERFACE_H

9
features/netsocket/MeshInterface.h
View File

@ -1,7 +1,4 @@
/*
/** \addtogroup netsocket */
/** @{*/
/* MeshInterface
* 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 MeshInterface.h Mesh network interface */
/** \addtogroup netinterface */
/** @{*/
#ifndef MESH_INTERFACE_H #ifndef MESH_INTERFACE_H
#define MESH_INTERFACE_H #define MESH_INTERFACE_H

3
features/netsocket/NetworkInterface.h
View File

@ -15,7 +15,8 @@
*/ */
/** @file NetworkInterface.h Network Interface base class */ /** @file NetworkInterface.h Network Interface base class */
/** @\addtogroup netsocket /** @addtogroup netinterface
* Network Interface classes
* @{ */ * @{ */

14
features/netsocket/WiFiInterface.h
View File

@ -1,5 +1,4 @@
/*
/* WiFiInterface
* Copyright (c) 2015 - 2016 ARM Limited * Copyright (c) 2015 - 2016 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,11 @@
* limitations under the License. * limitations under the License.
*/ */
/** @file WifiInterface.h Common interface that is shared between Wi-Fi devices */
/** @addtogroup netinterface
* @{
*/
#ifndef WIFI_INTERFACE_H #ifndef WIFI_INTERFACE_H
#define WIFI_INTERFACE_H #define WIFI_INTERFACE_H
@ -22,13 +26,7 @@
#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.
*
*/ */
class WiFiInterface: public virtual NetworkInterface { class WiFiInterface: public virtual NetworkInterface {
public: public:

9
features/netsocket/nsapi_dns.h
View File

@ -1,7 +1,4 @@
/*
/** \addtogroup netsocket */
/** @{*/
/* nsapi_dns.h
* Original work Copyright (c) 2013 Henry Leinen (henry[dot]leinen [at] online [dot] de) * Original work Copyright (c) 2013 Henry Leinen (henry[dot]leinen [at] online [dot] de)
* Modified work Copyright (c) 2015 ARM Limited * Modified work Copyright (c) 2015 ARM Limited
* *
@ -17,6 +14,10 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
/** \addtogroup netsocket */
/** @{*/
#ifndef NSAPI_DNS_H #ifndef NSAPI_DNS_H
#define NSAPI_DNS_H #define NSAPI_DNS_H