mirror of https://github.com/ARMmbed/mbed-os.git
Add missing Doxygen descriptions for Nanostack
Fix couple of parameter issues as well.pull/6313/head
parent
53cb6e06f9
commit
fbea6f15e2
|
@ -847,7 +847,8 @@ EXCLUDE_PATTERNS = */tools/* \
|
||||||
*/features/FEATURE_COMMON_PAL/* \
|
*/features/FEATURE_COMMON_PAL/* \
|
||||||
*/features/FEATURE_LWIP/* \
|
*/features/FEATURE_LWIP/* \
|
||||||
*/features/FEATURE_UVISOR/* \
|
*/features/FEATURE_UVISOR/* \
|
||||||
*/features/nanostack/* \
|
*/features/nanostack/FEATURE_NANOSTACK/sal-stack-nanostack/* \
|
||||||
|
*/features/nanostack/FEATURE_NANOSTACK/coap-service/* \
|
||||||
*/ble/generic/* \
|
*/ble/generic/* \
|
||||||
*/ble/pal/*
|
*/ble/pal/*
|
||||||
|
|
||||||
|
|
|
@ -9,5 +9,5 @@
|
||||||
"PREDEFINED": "DOXYGEN_ONLY DEVICE_ANALOGIN DEVICE_ANALOGOUT DEVICE_CAN DEVICE_ETHERNET DEVICE_EMAC DEVICE_FLASH DEVICE_I2C DEVICE_I2CSLAVE DEVICE_I2C_ASYNCH DEVICE_INTERRUPTIN DEVICE_ITM DEVICE_LOWPOWERTIMER DEVICE_PORTIN DEVICE_PORTINOUT DEVICE_PORTOUT DEVICE_PWMOUT DEVICE_RTC DEVICE_TRNG DEVICE_SERIAL DEVICE_SERIAL_ASYNCH DEVICE_SERIAL_FC DEVICE_SLEEP DEVICE_SPI DEVICE_SPI_ASYNCH DEVICE_SPISLAVE DEVICE_STORAGE \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\" \"MBED_DEPRECATED(s)=\"",
|
"PREDEFINED": "DOXYGEN_ONLY DEVICE_ANALOGIN DEVICE_ANALOGOUT DEVICE_CAN DEVICE_ETHERNET DEVICE_EMAC DEVICE_FLASH DEVICE_I2C DEVICE_I2CSLAVE DEVICE_I2C_ASYNCH DEVICE_INTERRUPTIN DEVICE_ITM DEVICE_LOWPOWERTIMER DEVICE_PORTIN DEVICE_PORTINOUT DEVICE_PORTOUT DEVICE_PWMOUT DEVICE_RTC DEVICE_TRNG DEVICE_SERIAL DEVICE_SERIAL_ASYNCH DEVICE_SERIAL_FC DEVICE_SLEEP DEVICE_SPI DEVICE_SPI_ASYNCH DEVICE_SPISLAVE DEVICE_STORAGE \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\" \"MBED_DEPRECATED(s)=\"",
|
||||||
"EXPAND_AS_DEFINED": "",
|
"EXPAND_AS_DEFINED": "",
|
||||||
"SKIP_FUNCTION_MACROS": "NO",
|
"SKIP_FUNCTION_MACROS": "NO",
|
||||||
"EXCLUDE_PATTERNS": "*/tools/* */targets/* */features/mbedtls/* */features/storage/* */features/unsupported/* */BUILD/* */rtos/TARGET_CORTEX/rtx*/* */cmsis/* */features/FEATURE_COMMON_PAL/* */features/FEATURE_LWIP/* */features/FEATURE_UVISOR/* */features/nanostack/* */ble/generic/* */ble/pal/*"
|
"EXCLUDE_PATTERNS": "*/tools/* */targets/* */features/mbedtls/* */features/storage/* */features/unsupported/* */BUILD/* */rtos/TARGET_CORTEX/rtx*/* */cmsis/* */features/FEATURE_COMMON_PAL/* */features/FEATURE_LWIP/* */features/FEATURE_UVISOR/* */features/nanostack/FEATURE_NANOSTACK/sal-stack-nanostack/* */features/nanostack/FEATURE_NANOSTACK/coap-service/* */ble/generic/* */ble/pal/*"
|
||||||
}
|
}
|
||||||
|
|
|
@ -19,6 +19,10 @@
|
||||||
|
|
||||||
#include "MeshInterfaceNanostack.h"
|
#include "MeshInterfaceNanostack.h"
|
||||||
|
|
||||||
|
/** 6LoWPAN-ND mesh network interface class
|
||||||
|
*
|
||||||
|
* Configure Nanostack to use 6LoWPAN-ND protocol.
|
||||||
|
*/
|
||||||
class LoWPANNDInterface : public MeshInterfaceNanostack {
|
class LoWPANNDInterface : public MeshInterfaceNanostack {
|
||||||
public:
|
public:
|
||||||
|
|
||||||
|
|
|
@ -22,6 +22,10 @@
|
||||||
#include "NanostackRfPhy.h"
|
#include "NanostackRfPhy.h"
|
||||||
#include "mesh_interface_types.h"
|
#include "mesh_interface_types.h"
|
||||||
|
|
||||||
|
/** Nanostack's network interface class.
|
||||||
|
*
|
||||||
|
* Common class that is shared between mesh interface classes
|
||||||
|
*/
|
||||||
class MeshInterfaceNanostack : public MeshInterface {
|
class MeshInterfaceNanostack : public MeshInterface {
|
||||||
public:
|
public:
|
||||||
|
|
||||||
|
@ -63,7 +67,7 @@ public:
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Callback from C-layer
|
* \brief Callback from C-layer
|
||||||
* \param state state of the network
|
* \param status state of the network
|
||||||
* */
|
* */
|
||||||
void mesh_network_handler(mesh_connection_status_t status);
|
void mesh_network_handler(mesh_connection_status_t status);
|
||||||
|
|
||||||
|
|
|
@ -20,6 +20,10 @@
|
||||||
#include "MeshInterfaceNanostack.h"
|
#include "MeshInterfaceNanostack.h"
|
||||||
#include "NanostackEthernetPhy.h"
|
#include "NanostackEthernetPhy.h"
|
||||||
|
|
||||||
|
/** Ethernet interface for Nanostack.
|
||||||
|
*
|
||||||
|
* Configure Nanostack to use Ethernet connectivity.
|
||||||
|
*/
|
||||||
class NanostackEthernetInterface : public MeshInterfaceNanostack {
|
class NanostackEthernetInterface : public MeshInterfaceNanostack {
|
||||||
public:
|
public:
|
||||||
|
|
||||||
|
|
|
@ -19,6 +19,10 @@
|
||||||
|
|
||||||
#include "MeshInterfaceNanostack.h"
|
#include "MeshInterfaceNanostack.h"
|
||||||
|
|
||||||
|
/** Thread mesh network interface class
|
||||||
|
*
|
||||||
|
* Configure Nanostack to use Thread protocol.
|
||||||
|
*/
|
||||||
class ThreadInterface : public MeshInterfaceNanostack {
|
class ThreadInterface : public MeshInterfaceNanostack {
|
||||||
public:
|
public:
|
||||||
|
|
||||||
|
|
|
@ -29,7 +29,7 @@ typedef enum {
|
||||||
MESH_TYPE_THREAD
|
MESH_TYPE_THREAD
|
||||||
} mesh_network_type_t;
|
} mesh_network_type_t;
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* Error status values returned by Mesh network API.
|
* Error status values returned by Mesh network API.
|
||||||
*/
|
*/
|
||||||
typedef enum {
|
typedef enum {
|
||||||
|
@ -40,7 +40,7 @@ typedef enum {
|
||||||
MESH_ERROR_PARAM, /*<! Illegal parameter */
|
MESH_ERROR_PARAM, /*<! Illegal parameter */
|
||||||
} mesh_error_t;
|
} mesh_error_t;
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* Mesh network connection status codes returned in callback.
|
* Mesh network connection status codes returned in callback.
|
||||||
*/
|
*/
|
||||||
typedef enum {
|
typedef enum {
|
||||||
|
@ -53,7 +53,7 @@ typedef enum {
|
||||||
MESH_BOOTSTRAP_STARTED /*<! bootstrap started */
|
MESH_BOOTSTRAP_STARTED /*<! bootstrap started */
|
||||||
} mesh_connection_status_t;
|
} mesh_connection_status_t;
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* Mesh device types
|
* Mesh device types
|
||||||
*/
|
*/
|
||||||
typedef enum {
|
typedef enum {
|
||||||
|
|
|
@ -20,6 +20,7 @@
|
||||||
|
|
||||||
#include "NanostackPhy.h"
|
#include "NanostackPhy.h"
|
||||||
|
|
||||||
|
/** Ethernet PHY driver class for Nanostack */
|
||||||
class NanostackEthernetPhy : public NanostackPhy {
|
class NanostackEthernetPhy : public NanostackPhy {
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
@ -29,6 +29,7 @@
|
||||||
|
|
||||||
struct ns_address;
|
struct ns_address;
|
||||||
|
|
||||||
|
/** Network interface class for Nanostack */
|
||||||
class NanostackInterface : public NetworkStack {
|
class NanostackInterface : public NetworkStack {
|
||||||
public:
|
public:
|
||||||
static NanostackInterface *get_stack();
|
static NanostackInterface *get_stack();
|
||||||
|
@ -179,7 +180,7 @@ protected:
|
||||||
*
|
*
|
||||||
* @param handle Socket handle
|
* @param handle Socket handle
|
||||||
* @param address Destination for the source address or NULL
|
* @param address Destination for the source address or NULL
|
||||||
* @param data Destination buffer for data received from the host
|
* @param buffer Destination buffer for data received from the host
|
||||||
* @param size Size of the buffer in bytes
|
* @param size Size of the buffer in bytes
|
||||||
* @return Number of received bytes on success, negative error
|
* @return Number of received bytes on success, negative error
|
||||||
* code on failure
|
* code on failure
|
||||||
|
|
|
@ -18,6 +18,7 @@
|
||||||
#ifndef NANOSTACK_PHY_H_
|
#ifndef NANOSTACK_PHY_H_
|
||||||
#define NANOSTACK_PHY_H_
|
#define NANOSTACK_PHY_H_
|
||||||
|
|
||||||
|
/** PHY driver class for Nanostack */
|
||||||
class NanostackPhy {
|
class NanostackPhy {
|
||||||
public:
|
public:
|
||||||
|
|
||||||
|
|
|
@ -20,6 +20,7 @@
|
||||||
|
|
||||||
#include "NanostackPhy.h"
|
#include "NanostackPhy.h"
|
||||||
|
|
||||||
|
/** Radio PHY driver class for Nanostack */
|
||||||
class NanostackRfPhy : public NanostackPhy {
|
class NanostackRfPhy : public NanostackPhy {
|
||||||
public:
|
public:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue