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

Merge pull request #11437 from hugueskamba/hk-harmonize-doxygen-grouping 

Harmonise Doxygen comments in drivers, events, platform and rtos dirs
pull/11448/head
Martin Kojtal 2019-09-10 10:56:41 +02:00 committed by GitHub
parent 1800632655 5933dec3b7
commit 0f1962e86d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
76 changed files with 176 additions and 211 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
drivers/AnalogIn.h
View File

@ -28,7 +28,7 @@
namespace mbed {
/** \defgroup mbed-os-public Public API */
/** \addtogroup drivers-public-api Drivers
/** \defgroup drivers-public-api Drivers
* \ingroup mbed-os-public
*/

2
drivers/AnalogOut.h
View File

@ -25,8 +25,6 @@
#include "platform/PlatformMutex.h"
namespace mbed {
/** \addtogroup drivers-public-api */
/**
* \defgroup drivers_AnalogOut AnalogOut class
* \ingroup drivers-public-api-gpio

3
drivers/Ethernet.h
View File

@ -23,9 +23,10 @@
#if DEVICE_ETHERNET || defined(DOXYGEN_ONLY)
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_Ethernet Ethernet class
* @{

2
drivers/FlashIAP.h
View File

@ -49,9 +49,9 @@ extern uint32_t Load$$LR$$LR_IROM1$$Limit[];
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_FlashIAP FlashIAP class
* @{

2
drivers/I2CSlave.h
View File

@ -25,7 +25,7 @@
namespace mbed {
/**
* \addtogroup drivers_I2CSlave I2CSlave class
* \defgroup drivers_I2CSlave I2CSlave class
* \ingroup drivers-public-api-i2c
* @{
*/

2
drivers/LowPowerTimeout.h
View File

@ -27,7 +27,7 @@
namespace mbed {
/**
* \addtogroup drivers_LowPowerTimeout LowPowerTimeout class
* \defgroup drivers_LowPowerTimeout LowPowerTimeout class
* \ingroup drivers-public-api-ticker
* @{
*/

2
drivers/LowPowerTimer.h
View File

@ -27,7 +27,7 @@
namespace mbed {
/**
* \addtogroup drivers_LowPowerTimer LowPowerTimer class
* \defgroup drivers_LowPowerTimer LowPowerTimer class
* \ingroup drivers-public-api-ticker
* @{
*/

1
drivers/MbedCRC.h
View File

@ -40,7 +40,6 @@ but we check for ( width < 8) before performing shift, so it should not be an is
#endif
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup drivers-public-api */
/** @{*/
/**

2
drivers/ResetReason.h
View File

@ -22,9 +22,9 @@
#include "reset_reason_api.h"
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_ResetReason ResetReason class
* @{

2
drivers/SPI.h
View File

@ -46,7 +46,7 @@
namespace mbed {
/**
* \addtogroup drivers_SPI SPI class
* \defgroup drivers_SPI SPI class
* \ingroup drivers-public-api-spi
* @{
*/

2
drivers/Ticker.h
View File

@ -26,7 +26,7 @@
namespace mbed {
/**
* \addtogroup drivers_Ticker Ticker class
* \defgroup drivers_Ticker Ticker class
* \ingroup drivers-public-api-ticker
* @{
*/

2
drivers/Timeout.h
View File

@ -22,7 +22,7 @@
namespace mbed {
/**
* \addtogroup drivers_Timeout Timeout class
* \defgroup drivers_Timeout Timeout class
* \ingroup drivers-public-api-ticker
* @{
*/

2
drivers/Timer.h
View File

@ -23,7 +23,7 @@
namespace mbed {
/**
* \addtogroup drivers_Timer Timer class
* \defgroup drivers_Timer Timer class
* \ingroup drivers-public-api-ticker
* @{
*/

2
drivers/TimerEvent.h
View File

@ -22,7 +22,7 @@
namespace mbed {
/**
* \addtogroup drivers_TimerEvent TimerEvent class
* \defgroup drivers_TimerEvent TimerEvent class
* \ingroup drivers-public-api-ticker
* @{
*/

2
drivers/internal/MIDIMessage.h
View File

@ -43,7 +43,7 @@
/**
* \defgroup drivers_MIDIMessage MIDIMessage class
* \ingroup drivers-internal-usb
* \ingroup drivers-internal-api-usb
* @{
*/

1
drivers/internal/TableCRC.h
View File

@ -22,7 +22,6 @@
namespace mbed {
/** \addtogroup drivers-internal-api
* \ingroup mbed-os-internal
* @{
*/

3
events/Event.h
View File

@ -21,8 +21,7 @@
#include "platform/mbed_assert.h"
namespace events {
/**
* \addtogroup events-public-api Events
/** \defgroup events-public-api Events
* \ingroup mbed-os-public
* @{
*/

3
events/UserAllocatedEvent.h
View File

@ -23,8 +23,7 @@
namespace events {
/**
* \addtogroup events-public-api Events
* \ingroup mbed-os-public
* \addtogroup events-public-api
* @{
*/
template <typename F, typename A>

1
events/mbed_shared_queues.h
View File

@ -19,7 +19,6 @@
#include "events/EventQueue.h"
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup events-public-api */
/** @{*/

2
platform/ATCmdParser.h
View File

@ -27,8 +27,6 @@
#include "platform/FileHandle.h"
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api Platform */
/** @{*/
/**

25
platform/CThunk.h
View File

@ -1,18 +1,4 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_CThunk CThunk class
* @{
*/
/* General C++ Object Thunking class
*
* - allows direct callbacks to non-static C++ class functions
* - keeps track for the corresponding class instance
* - supports an optional context parameter for the called function
* - ideally suited for class object receiving interrupts (NVIC_SetVector)
*
* Copyright (c) 2014-2019 ARM Limited
/* Copyright (c) 2014-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 (the "License");
@ -28,6 +14,15 @@
* limitations under the License.
*/
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_CThunk CThunk class
* @{
*/
/* General C++ Object Thunking class
*
* - allows direct callbacks to non-static C++ class functions

1
platform/Callback.h
View File

@ -24,7 +24,6 @@
#include "platform/mbed_toolchain.h"
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**

1
platform/CircularBuffer.h
View File

@ -51,7 +51,6 @@ struct is_unsigned<unsigned long long> {
};
};
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**

2
platform/CriticalSectionLock.h
View File

@ -21,8 +21,6 @@
#include "platform/mbed_toolchain.h"
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**

2
platform/DeepSleepLock.h
View File

@ -21,8 +21,6 @@
#include <stdint.h>
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**

1
platform/DirHandle.h
View File

@ -22,7 +22,6 @@
#include "platform/NonCopyable.h"
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**

1
platform/FunctionPointer.h
View File

@ -23,7 +23,6 @@
#include <stdint.h>
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**

1
platform/LocalFileSystem.h
View File

@ -26,7 +26,6 @@
#include "platform/NonCopyable.h"
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**

2
platform/NonCopyable.h
View File

@ -24,9 +24,9 @@
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_NonCopyable NonCopyable class
* @{

1
platform/PlatformMutex.h
View File

@ -19,7 +19,6 @@
#include "platform/NonCopyable.h"
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

2
platform/ScopedLock.h
View File

@ -21,9 +21,9 @@
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_ScopedLock ScopedLock functions
* @{

1
platform/ScopedRamExecutionLock.h
View File

@ -21,7 +21,6 @@
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

1
platform/ScopedRomWriteLock.h
View File

@ -21,7 +21,6 @@
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

16
platform/SingletonPtr.h
View File

@ -1,11 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_SingletonPtr SingletonPtr class
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -38,6 +30,14 @@
extern osMutexId_t singleton_mutex_id;
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_SingletonPtr SingletonPtr class
* @{
*/
/** Lock the singleton mutex
*
* This function is typically used to provide

2
platform/Span.h
View File

@ -26,9 +26,9 @@
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_Span Span class
* @{

2
platform/Stream.h
View File

@ -25,9 +25,9 @@
#include <cstdarg>
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_Stream Stream class
* @{

2
platform/Transaction.h
View File

@ -20,9 +20,9 @@
#include "platform/platform.h"
namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_Transaction Transaction class
* @{

2
platform/internal/CThunkBase.h
View File

@ -18,7 +18,7 @@
#ifndef __CTHUNK_BASE_H__
#define __CTHUNK_BASE_H__
/** \addtogroup platform-internal-api Platform
/** \defgroup platform-internal-api Platform
* \ingroup mbed-os-internal
*/

16
platform/mbed_assert.h
View File

@ -1,11 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_Assert Assert macros
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -31,6 +23,14 @@
extern "C" {
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_Assert Assert macros
* @{
*/
/** Internal mbed assert function which is invoked when MBED_ASSERT macro fails.
* This function is active only if NDEBUG is not defined prior to including this
* assert header file.

1
platform/mbed_atomic.h
View File

@ -26,7 +26,6 @@
#include <stddef.h>
#include "platform/mbed_toolchain.h"
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

2
platform/mbed_critical.h
View File

@ -1,4 +1,3 @@
/*
* Copyright (c) 2015-2019, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0
@ -25,7 +24,6 @@
extern "C" {
#endif
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**

17
platform/mbed_debug.h
View File

@ -1,12 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_debug Debug functions
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -35,6 +26,14 @@
extern "C" {
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_debug Debug functions
* @{
*/
static inline void debug(const char *format, ...) MBED_PRINTF(1, 2);
static inline void debug_if(int condition, const char *format, ...) MBED_PRINTF(2, 3);

15
platform/mbed_error.h
View File

@ -1,10 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_error Error functions
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -32,6 +25,14 @@
extern "C" {
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_error Error functions
* @{
*/
/** Define this macro to include filenames in error context. For release builds, do not include filename to save memory.
* MBED_PLATFORM_CONF_ERROR_FILENAME_CAPTURE_ENABLED
*/

17
platform/mbed_interface.h
View File

@ -1,12 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_interface Network interface and other utility functions
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -31,6 +22,14 @@
#include "platform/mbed_toolchain.h"
#include "device.h"
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_interface Network interface and other utility functions
* @{
*/
/* Mbed interface mac address
* if MBED_MAC_ADD_x are zero, interface uid sets mac address,
* otherwise MAC_ADD_x are used.

8
platform/mbed_mem_trace.h
View File

@ -1,8 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -30,6 +25,9 @@ extern "C" {
#include <stdint.h>
#include <stddef.h>
/** \addtogroup platform-public-api */
/** @{*/
/**
* enum Memory operation types for tracer
*/

7
platform/mbed_mktime.h
View File

@ -1,7 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/* mbed Microcontroller Library
* Copyright (c) 2017-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -30,6 +26,9 @@
extern "C" {
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_mktime mktime functions
* @{

16
platform/mbed_mpu_mgmt.h
View File

@ -1,11 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_mpu_mgmt MPU management functions
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
*
@ -30,6 +22,14 @@
extern "C" {
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_mpu_mgmt MPU management functions
* @{
*/
#if (DEVICE_MPU && MBED_CONF_PLATFORM_USE_MPU) || defined(DOXYGEN_ONLY)
#define mbed_mpu_manager_init() mbed_mpu_init()

2
platform/mbed_poll.h
View File

@ -27,9 +27,9 @@ namespace mbed {
class FileHandle;
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_poll poll functions
* @{

16
platform/mbed_power_mgmt.h
View File

@ -1,11 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_power_mgmt Power management functions
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -34,6 +26,14 @@
extern "C" {
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_power_mgmt Power management functions
* @{
*/
/**
* @defgroup hal_sleep_manager Sleep manager API
* The sleep manager provides API to automatically select sleep mode.

15
platform/mbed_preprocessor.h
View File

@ -1,11 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_preprocessor preprocessor macros
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -25,6 +17,13 @@
#ifndef MBED_PREPROCESSOR_H
#define MBED_PREPROCESSOR_H
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_preprocessor preprocessor macros
* @{
*/
/** MBED_CONCAT
* Concatenate tokens together

2
platform/mbed_retarget.h
View File

@ -79,9 +79,9 @@ typedef unsigned int gid_t; ///< Group ID
#include <time.h>
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_retarget Retarget functions
* @{

16
platform/mbed_rtc_time.h
View File

@ -1,11 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_rtc_time rtc_time functions
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -29,6 +21,14 @@
extern "C" {
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_rtc_time rtc_time functions
* @{
*/
/* Timeval definition for non GCC_ARM toolchains */
#if !defined(__GNUC__) || defined(__CC_ARM) || defined(__clang__)
struct timeval {

16
platform/mbed_stats.h
View File

@ -1,11 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_stats stats functions
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2016-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -32,6 +24,14 @@
extern "C" {
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_stats stats functions
* @{
*/
#ifdef MBED_ALL_STATS_ENABLED
#ifndef MBED_SYS_STATS_ENABLED

16
platform/mbed_toolchain.h
View File

@ -1,12 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_toolchain Toolchain functions
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -37,6 +28,13 @@
#warning "This compiler is not yet supported."
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_toolchain Toolchain functions
* @{
*/
// Attributes

16
platform/mbed_version.h
View File

@ -1,11 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_version Version macros
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2018-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -26,6 +18,14 @@
#ifndef MBED_VERSION_H
#define MBED_VERSION_H
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_version Version macros
* @{
*/
/** MBED_MAJOR_VERSION
* Mbed OS major version
*

17
platform/mbed_wait_api.h
View File

@ -1,12 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_wait_api wait_api functions
* @{
*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -34,6 +25,14 @@
extern "C" {
#endif
/** \addtogroup platform-public-api */
/** @{*/
/**
* \defgroup platform_wait_api wait_api functions
* @{
*/
/** Generic wait functions.
*
* These provide simple NOP type wait capabilities.

4
platform/platform.h
View File

@ -29,4 +29,8 @@
#include "PinNames.h"
#include "PeripheralNames.h"
/** \defgroup platform-public-api Platform
* \ingroup mbed-os-public
*/
#endif

6
platform/toolchain.h
View File

@ -1,7 +1,3 @@
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/* mbed Microcontroller Library
* Copyright (c) 2006-2019 ARM Limited
* SPDX-License-Identifier: Apache-2.0
@ -26,5 +22,3 @@
#include "platform/mbed_toolchain.h"
#endif
/** @}*/

3
rtos/ConditionVariable.h
View File

@ -32,8 +32,7 @@
#if MBED_CONF_RTOS_PRESENT || defined(DOXYGEN_ONLY)
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api RTOS */
/** \addtogroup rtos-public-api */
/** @{*/
struct Waiter;

2
rtos/EventFlags.h
View File

@ -31,9 +31,9 @@
#include "platform/NonCopyable.h"
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/
/**
* \defgroup rtos_EventFlags EventFlags class
* @{

2
rtos/Kernel.h
View File

@ -26,7 +26,6 @@
#include "rtos/mbed_rtos_types.h"
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/
@ -62,5 +61,6 @@ void attach_thread_terminate_hook(void (*fptr)(osThreadId_t id));
} // namespace Kernel
/** @}*/
} // namespace rtos
#endif

2
rtos/Mail.h
View File

@ -41,9 +41,9 @@ using namespace rtos;
#if MBED_CONF_RTOS_PRESENT || defined(DOXYGEN_ONLY)
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/
/**
* \defgroup rtos_Mail Mail class
* @{

3
rtos/MemoryPool.h
View File

@ -35,9 +35,9 @@
#if MBED_CONF_RTOS_PRESENT || defined(DOXYGEN_ONLY)
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/
/**
* \defgroup rtos_MemoryPool MemoryPool class
* @{
@ -193,7 +193,6 @@ private:
};
/** @}*/
/** @}*/
}
#endif
#endif

1
rtos/Mutex.h
View File

@ -32,7 +32,6 @@
#include "platform/mbed_toolchain.h"
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/

2
rtos/Queue.h
View File

@ -31,9 +31,9 @@
#if MBED_CONF_RTOS_PRESENT || defined(DOXYGEN_ONLY)
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/
/**
* \defgroup rtos_Queue Queue class
* @{

2
rtos/RtosTimer.h
View File

@ -33,9 +33,9 @@
#if MBED_CONF_RTOS_PRESENT || defined(DOXYGEN_ONLY)
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/
/**
* \defgroup rtos_RtosTimer RtosTimer class
* @{

2
rtos/Semaphore.h
View File

@ -30,9 +30,9 @@
#include "platform/NonCopyable.h"
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/
/**
* \defgroup rtos_Semaphore Semaphore class
* @{

7
rtos/ThisThread.h
View File

@ -26,9 +26,9 @@
#include "rtos/mbed_rtos_types.h"
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/
/**
* \defgroup rtos_ThisThread ThisThread namespace
* @{
@ -185,7 +185,11 @@ const char *get_name();
/** @}*/
/** @}*/
namespace internal {
/** \addtogroup rtos-internal-api */
/** @{*/
struct flags_check_capture {
uint32_t *flags;
uint32_t options;
@ -197,5 +201,6 @@ struct flags_check_capture {
bool non_rtos_check_flags(void *handle);
}
/** @}*/
}
#endif

2
rtos/Thread.h
View File

@ -35,9 +35,9 @@
#if MBED_CONF_RTOS_PRESENT || defined(DOXYGEN_ONLY) || defined(UNITTEST)
namespace rtos {
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/
/**
* \defgroup rtos_Thread Thread class
* @{

2
rtos/mbed_rtos_storage.h
View File

@ -24,5 +24,3 @@
#endif
#endif
/** @}*/

6
rtos/mbed_rtos_types.h
View File

@ -25,6 +25,9 @@
extern "C" {
#endif
/** \addtogroup rtos-public-api */
/** @{*/
/* Minimal definitions for bare metal form of RTOS */
// Timeout value.
@ -65,6 +68,8 @@ typedef void *osThreadId_t;
// \return thread flags after setting or error code if highest bit set.
uint32_t osThreadFlagsSet(osThreadId_t thread_id, uint32_t flags);
/** @}*/
#ifdef __cplusplus
}
#endif
@ -72,5 +77,4 @@ uint32_t osThreadFlagsSet(osThreadId_t thread_id, uint32_t flags);
#endif
#endif /* RTOS_TYPES_H_ */

9
rtos/rtos.h
View File

@ -36,12 +36,13 @@
#include "rtos/EventFlags.h"
#include "rtos/ConditionVariable.h"
/** \ingroup mbed-os-public */
/** \addtogroup rtos-public-api */
/** @{*/
/** \defgroup rtos-public-api RTOS
* \ingroup mbed-os-public
*/
#ifndef MBED_NO_GLOBAL_USING_DIRECTIVE
using namespace rtos;
#endif
/** @}*/
#endif

1
rtos/source/TARGET_CORTEX/mbed_boot.h
View File

@ -25,7 +25,6 @@ extern "C" {
#include "mbed_rtx.h"
/** \ingroup mbed-os-internal */
/** \addtogroup rtos-internal-api */
/** @{*/

8
rtos/source/rtos_handlers.h
View File

@ -28,12 +28,13 @@
extern "C" {
#endif
/** \ingroup mbed-os-internal */
/** \addtogroup rtos-internal-api RTOS */
/** @{*/
/** \defgroup rtos-internal-api RTOS
* \ingroup mbed-os-internal
*/
/**
* \defgroup rtos_handlers RTOS hook functions
* \ingroup rtos-internal-api
* @{
*/
/**
@ -43,7 +44,6 @@ extern "C" {
*/
void rtos_attach_thread_terminate_hook(void (*fptr)(osThreadId_t id));
/** @}*/
/** @}*/
#ifdef __cplusplus
}

2
rtos/source/rtos_idle.h
View File

@ -28,8 +28,6 @@
extern "C" {
#endif
/** \ingroup mbed-os-internal */
/** \addtogroup rtos-internal-api */
/** @{*/

1
tools/test/travis-ci/doxy-spellchecker/ignore.en.pws
View File

@ -109,4 +109,5 @@ xmit
pppd
pppdebug
ppp
api
_doxy_