Skip to content

Commit 961632a

Browse files
Clean up group/module definitions in doxygen (#97)
* Clean up group definitions in doxygen * remove THIRD_PARTY_DOCS * some stragglers * fix astyle formatting
1 parent e4469c3 commit 961632a

File tree

134 files changed

+293
-472
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

134 files changed

+293
-472
lines changed

connectivity/FEATURE_BLE/include/ble/BLE.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -475,15 +475,16 @@ class BLE {
475475
bool event_signaled;
476476
};
477477

478-
}
479478

480-
using ble::BLE;
481479
/**
482-
* @namespace ble Entry namespace for all BLE API definitions.
480+
* @}
483481
*/
484482

483+
}
484+
485+
using ble::BLE;
485486
/**
486-
* @}
487+
* @namespace ble Entry namespace for all BLE API definitions.
487488
*/
488489

489490
#endif /* ifndef MBED_BLE_H__ */

connectivity/FEATURE_BLE/include/ble/common/blecommon.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ extern "C" {
2424
#endif
2525

2626
/**
27-
* @addtogroup ble
27+
* @defgroup ble Bluetooth
28+
* @ingroup connectivity-public-api
2829
* @{
2930
* @addtogroup common
3031
* @{

connectivity/FEATURE_BLE/libraries/TARGET_CORDIO_LL/stack/controller/include/common/bb_api.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ uint32_t BbGetTargetTimeDelta(uint32_t targetUsec, uint32_t refUsec);
397397
/*************************************************************************************************/
398398
uint8_t BbGetActiveProtocol(void);
399399

400-
/*! \} */ /* BB_API_CTRL */
400+
/*! \} */ /* BB_API_CTRL */
401401

402402
#ifdef __cplusplus
403403
};

connectivity/FEATURE_BLE/libraries/TARGET_CORDIO_LL/stack/thirdparty/nordic-bsp/components/boards/boards.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/**
1+
/*
22
* Copyright (c) 2014 - 2019, Nordic Semiconductor ASA
33
*
44
* All rights reserved.
@@ -37,6 +37,7 @@
3737
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3838
*
3939
*/
40+
4041
#ifndef BOARDS_H
4142
#define BOARDS_H
4243

@@ -92,7 +93,8 @@
9293
extern "C" {
9394
#endif
9495

95-
/**@defgroup BSP_BOARD_INIT_FLAGS Board initialization flags.
96+
/**
97+
* @defgroup BSP_BOARD_INIT_FLAGS Board initialization flags.
9698
* @{ */
9799
#define BSP_INIT_NONE 0 /**< No initialization of LEDs or buttons (@ref bsp_board_init).*/
98100
#define BSP_INIT_LEDS (1 << 0) /**< Enable LEDs during initialization (@ref bsp_board_init).*/

connectivity/cellular/include/CellularNonIPSocket.h

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

3030
namespace mbed {
3131

32-
/** \addtogroup netsocket */
32+
/** \addtogroup NetSocket */
3333
/** @{*/
3434

3535
/** Socket implementation for cellular Non-IP data delivery(NIDD).

connectivity/cellular/include/cellular/framework/API/CellularContext.h

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,12 @@
3232
namespace mbed {
3333

3434
/**
35-
* @addtogroup cellular
35+
* @defgroup connectivity-public-api Connectivity
36+
* @ingroup mbed-os-public
37+
* @{
38+
39+
* @defgroup Cellular
40+
* @ingroup connectivity-public-api
3641
* @{
3742
*/
3843

@@ -396,6 +401,7 @@ class CellularContext : public CellularInterface {
396401
};
397402

398403
/**
404+
* @}
399405
* @}
400406
*/
401407

connectivity/cellular/include/cellular/framework/API/CellularDevice.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ const int MAX_PLMN_SIZE = 16;
4343
const int MAX_SIM_READY_WAITING_TIME = 30;
4444

4545
/**
46-
* @addtogroup cellular
46+
* @addtogroup Cellular
4747
* @{
4848
*/
4949

connectivity/cellular/include/cellular/framework/API/CellularInformation.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ const int MAX_ICCID_LENGTH = 20 + 1; // +1 for zero termination
2727
namespace mbed {
2828

2929
/**
30-
* @addtogroup cellular
30+
* @addtogroup Cellular
3131
* @{
3232
*/
3333

connectivity/cellular/include/cellular/framework/API/CellularNetwork.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ const int MAX_OPERATOR_NAME_LONG = 16;
3131
const int MAX_OPERATOR_NAME_SHORT = 8;
3232

3333
/**
34-
* @addtogroup cellular
34+
* @addtogroup Cellular
3535
* @{
3636
*/
3737

connectivity/cellular/include/cellular/framework/API/CellularSMS.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ const uint16_t SMS_SIM_WAIT_TIME_MILLISECONDS = 200;
3838
const int SMS_ERROR_MULTIPART_ALL_PARTS_NOT_READ = -5001;
3939

4040
/**
41-
* @addtogroup cellular
41+
* @addtogroup Cellular
4242
* @{
4343
*/
4444

0 commit comments

Comments
 (0)