From fbea6f15e2bd81ccc2b87bd9b36f482b21c47590 Mon Sep 17 00:00:00 2001 From: Seppo Takalo Date: Thu, 8 Mar 2018 15:53:07 +0200 Subject: [PATCH] Add missing Doxygen descriptions for Nanostack Fix couple of parameter issues as well. --- doxyfile_options | 3 ++- doxygen_options.json | 2 +- .../mbed-mesh-api/mbed-mesh-api/LoWPANNDInterface.h | 4 ++++ .../mbed-mesh-api/mbed-mesh-api/MeshInterfaceNanostack.h | 6 +++++- .../mbed-mesh-api/NanostackEthernetInterface.h | 4 ++++ .../mbed-mesh-api/mbed-mesh-api/ThreadInterface.h | 4 ++++ .../mbed-mesh-api/mbed-mesh-api/mesh_interface_types.h | 6 +++--- .../nanostack-interface/NanostackEthernetPhy.h | 1 + .../nanostack-interface/NanostackInterface.h | 3 ++- .../FEATURE_NANOSTACK/nanostack-interface/NanostackPhy.h | 1 + .../FEATURE_NANOSTACK/nanostack-interface/NanostackRfPhy.h | 1 + 11 files changed, 28 insertions(+), 7 deletions(-) diff --git a/doxyfile_options b/doxyfile_options index ad9497fc1d..a189be070e 100644 --- a/doxyfile_options +++ b/doxyfile_options @@ -847,7 +847,8 @@ EXCLUDE_PATTERNS = */tools/* \ */features/FEATURE_COMMON_PAL/* \ */features/FEATURE_LWIP/* \ */features/FEATURE_UVISOR/* \ - */features/nanostack/* \ + */features/nanostack/FEATURE_NANOSTACK/sal-stack-nanostack/* \ + */features/nanostack/FEATURE_NANOSTACK/coap-service/* \ */ble/generic/* \ */ble/pal/* diff --git a/doxygen_options.json b/doxygen_options.json index f25f70ce43..4d0530b0e9 100644 --- a/doxygen_options.json +++ b/doxygen_options.json @@ -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)=\"", "EXPAND_AS_DEFINED": "", "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/*" } diff --git a/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/LoWPANNDInterface.h b/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/LoWPANNDInterface.h index 838d9bddc3..537f04aee0 100644 --- a/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/LoWPANNDInterface.h +++ b/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/LoWPANNDInterface.h @@ -19,6 +19,10 @@ #include "MeshInterfaceNanostack.h" +/** 6LoWPAN-ND mesh network interface class + * + * Configure Nanostack to use 6LoWPAN-ND protocol. + */ class LoWPANNDInterface : public MeshInterfaceNanostack { public: diff --git a/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/MeshInterfaceNanostack.h b/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/MeshInterfaceNanostack.h index 59d8b477ce..15c6bc207a 100644 --- a/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/MeshInterfaceNanostack.h +++ b/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/MeshInterfaceNanostack.h @@ -22,6 +22,10 @@ #include "NanostackRfPhy.h" #include "mesh_interface_types.h" +/** Nanostack's network interface class. + * + * Common class that is shared between mesh interface classes + */ class MeshInterfaceNanostack : public MeshInterface { public: @@ -63,7 +67,7 @@ public: /** * \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); diff --git a/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/NanostackEthernetInterface.h b/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/NanostackEthernetInterface.h index 45235e103a..1d38281c7b 100644 --- a/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/NanostackEthernetInterface.h +++ b/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/NanostackEthernetInterface.h @@ -20,6 +20,10 @@ #include "MeshInterfaceNanostack.h" #include "NanostackEthernetPhy.h" +/** Ethernet interface for Nanostack. + * + * Configure Nanostack to use Ethernet connectivity. + */ class NanostackEthernetInterface : public MeshInterfaceNanostack { public: diff --git a/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/ThreadInterface.h b/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/ThreadInterface.h index a1eacf1d41..4e133243a3 100644 --- a/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/ThreadInterface.h +++ b/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/ThreadInterface.h @@ -19,6 +19,10 @@ #include "MeshInterfaceNanostack.h" +/** Thread mesh network interface class + * + * Configure Nanostack to use Thread protocol. + */ class ThreadInterface : public MeshInterfaceNanostack { public: diff --git a/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/mesh_interface_types.h b/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/mesh_interface_types.h index 212dbf7814..7a6846955d 100644 --- a/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/mesh_interface_types.h +++ b/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/mesh_interface_types.h @@ -29,7 +29,7 @@ typedef enum { MESH_TYPE_THREAD } mesh_network_type_t; -/* +/** * Error status values returned by Mesh network API. */ typedef enum { @@ -40,7 +40,7 @@ typedef enum { MESH_ERROR_PARAM, /*