Skip to content

Harmonise Doxygen comments in drivers, events, platform and rtos dirs #11437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion drivers/AnalogIn.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 0 additions & 2 deletions drivers/AnalogOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@
#include "platform/PlatformMutex.h"

namespace mbed {
/** \addtogroup drivers-public-api */

/**
* \defgroup drivers_AnalogOut AnalogOut class
* \ingroup drivers-public-api-gpio
Expand Down
3 changes: 2 additions & 1 deletion drivers/Ethernet.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
Expand Down
2 changes: 1 addition & 1 deletion drivers/FlashIAP.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
Expand Down
2 changes: 1 addition & 1 deletion drivers/I2CSlave.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

namespace mbed {
/**
* \addtogroup drivers_I2CSlave I2CSlave class
* \defgroup drivers_I2CSlave I2CSlave class
* \ingroup drivers-public-api-i2c
* @{
*/
Expand Down
2 changes: 1 addition & 1 deletion drivers/LowPowerTimeout.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

namespace mbed {
/**
* \addtogroup drivers_LowPowerTimeout LowPowerTimeout class
* \defgroup drivers_LowPowerTimeout LowPowerTimeout class
* \ingroup drivers-public-api-ticker
* @{
*/
Expand Down
2 changes: 1 addition & 1 deletion drivers/LowPowerTimer.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

namespace mbed {
/**
* \addtogroup drivers_LowPowerTimer LowPowerTimer class
* \defgroup drivers_LowPowerTimer LowPowerTimer class
* \ingroup drivers-public-api-ticker
* @{
*/
Expand Down
1 change: 0 additions & 1 deletion drivers/MbedCRC.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 */
/** @{*/
/**
Expand Down
2 changes: 1 addition & 1 deletion drivers/ResetReason.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
#include "reset_reason_api.h"

namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup drivers-public-api */
/** @{*/

/**
* \defgroup drivers_ResetReason ResetReason class
* @{
Expand Down
2 changes: 1 addition & 1 deletion drivers/SPI.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@

namespace mbed {
/**
* \addtogroup drivers_SPI SPI class
* \defgroup drivers_SPI SPI class
* \ingroup drivers-public-api-spi
* @{
*/
Expand Down
2 changes: 1 addition & 1 deletion drivers/Ticker.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

namespace mbed {
/**
* \addtogroup drivers_Ticker Ticker class
* \defgroup drivers_Ticker Ticker class
* \ingroup drivers-public-api-ticker
* @{
*/
Expand Down
2 changes: 1 addition & 1 deletion drivers/Timeout.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

namespace mbed {
/**
* \addtogroup drivers_Timeout Timeout class
* \defgroup drivers_Timeout Timeout class
* \ingroup drivers-public-api-ticker
* @{
*/
Expand Down
2 changes: 1 addition & 1 deletion drivers/Timer.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

namespace mbed {
/**
* \addtogroup drivers_Timer Timer class
* \defgroup drivers_Timer Timer class
* \ingroup drivers-public-api-ticker
* @{
*/
Expand Down
2 changes: 1 addition & 1 deletion drivers/TimerEvent.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

namespace mbed {
/**
* \addtogroup drivers_TimerEvent TimerEvent class
* \defgroup drivers_TimerEvent TimerEvent class
* \ingroup drivers-public-api-ticker
* @{
*/
Expand Down
2 changes: 1 addition & 1 deletion drivers/internal/MIDIMessage.h
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@

/**
* \defgroup drivers_MIDIMessage MIDIMessage class
* \ingroup drivers-internal-usb
* \ingroup drivers-internal-api-usb
* @{
*/

Expand Down
1 change: 0 additions & 1 deletion drivers/internal/TableCRC.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@

namespace mbed {
/** \addtogroup drivers-internal-api
* \ingroup mbed-os-internal
* @{
*/

Expand Down
3 changes: 1 addition & 2 deletions events/Event.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
3 changes: 1 addition & 2 deletions events/UserAllocatedEvent.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@

namespace events {
/**
* \addtogroup events-public-api Events
* \ingroup mbed-os-public
* \addtogroup events-public-api
* @{
*/
template <typename F, typename A>
Expand Down
1 change: 0 additions & 1 deletion events/mbed_shared_queues.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
#include "events/EventQueue.h"

namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup events-public-api */
/** @{*/

Expand Down
2 changes: 0 additions & 2 deletions platform/ATCmdParser.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@
#include "platform/FileHandle.h"

namespace mbed {

/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api Platform */
/** @{*/
/**
Expand Down
25 changes: 10 additions & 15 deletions platform/CThunk.h
Original file line number Diff line number Diff line change
@@ -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");
Expand All @@ -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
Expand Down
1 change: 0 additions & 1 deletion platform/Callback.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
#include "platform/mbed_toolchain.h"

namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
Expand Down
1 change: 0 additions & 1 deletion platform/CircularBuffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ struct is_unsigned<unsigned long long> {
};
};

/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
Expand Down
2 changes: 0 additions & 2 deletions platform/CriticalSectionLock.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
#include "platform/mbed_toolchain.h"

namespace mbed {

/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
Expand Down
2 changes: 0 additions & 2 deletions platform/DeepSleepLock.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
#include <stdint.h>

namespace mbed {

/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
Expand Down
1 change: 0 additions & 1 deletion platform/DirHandle.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
#include "platform/NonCopyable.h"

namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
Expand Down
1 change: 0 additions & 1 deletion platform/FunctionPointer.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
#include <stdint.h>

namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
Expand Down
1 change: 0 additions & 1 deletion platform/LocalFileSystem.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
#include "platform/NonCopyable.h"

namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/
/**
Expand Down
2 changes: 1 addition & 1 deletion platform/NonCopyable.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@

namespace mbed {

/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

/**
* \defgroup platform_NonCopyable NonCopyable class
* @{
Expand Down
1 change: 0 additions & 1 deletion platform/PlatformMutex.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

#include "platform/NonCopyable.h"

/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

Expand Down
2 changes: 1 addition & 1 deletion platform/ScopedLock.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@

namespace mbed {

/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

/**
* \defgroup platform_ScopedLock ScopedLock functions
* @{
Expand Down
1 change: 0 additions & 1 deletion platform/ScopedRamExecutionLock.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@

namespace mbed {

/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

Expand Down
1 change: 0 additions & 1 deletion platform/ScopedRomWriteLock.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@

namespace mbed {

/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

Expand Down
16 changes: 8 additions & 8 deletions platform/SingletonPtr.h
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion platform/Span.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@

namespace mbed {

/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

/**
* \defgroup platform_Span Span class
* @{
Expand Down
2 changes: 1 addition & 1 deletion platform/Stream.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
#include <cstdarg>

namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

/**
* \defgroup platform_Stream Stream class
* @{
Expand Down
2 changes: 1 addition & 1 deletion platform/Transaction.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
#include "platform/platform.h"

namespace mbed {
/** \ingroup mbed-os-public */
/** \addtogroup platform-public-api */
/** @{*/

/**
* \defgroup platform_Transaction Transaction class
* @{
Expand Down
2 changes: 1 addition & 1 deletion platform/internal/CThunkBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
Loading