Add tags to our code

pull/2911/head
Jimmy Brisson 2016-10-04 15:02:44 -05:00
parent 2cea844199
commit f1a78027d3
144 changed files with 663 additions and 0 deletions

View File

@ -25,6 +25,8 @@
#include "platform/PlatformMutex.h" #include "platform/PlatformMutex.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** An analog input, used for reading the voltage on a pin /** An analog input, used for reading the voltage on a pin
* *
@ -126,3 +128,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -24,6 +24,8 @@
#include "platform/PlatformMutex.h" #include "platform/PlatformMutex.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** An analog output, used for setting the voltage on a pin /** An analog output, used for setting the voltage on a pin
* *
@ -144,3 +146,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -21,6 +21,8 @@
#include "platform/PlatformMutex.h" #include "platform/PlatformMutex.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A digital input bus, used for reading the state of a collection of pins /** A digital input bus, used for reading the state of a collection of pins
* *
@ -102,3 +104,5 @@ private:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -20,6 +20,8 @@
#include "platform/PlatformMutex.h" #include "platform/PlatformMutex.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A digital input output bus, used for setting the state of a collection of pins /** A digital input output bus, used for setting the state of a collection of pins
* *
@ -121,3 +123,5 @@ private:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -20,6 +20,8 @@
#include "platform/PlatformMutex.h" #include "platform/PlatformMutex.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A digital output bus, used for setting the state of a collection of pins /** A digital output bus, used for setting the state of a collection of pins
*/ */
@ -105,3 +107,5 @@ private:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -25,6 +25,8 @@
#include "platform/PlatformMutex.h" #include "platform/PlatformMutex.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** CANMessage class /** CANMessage class
* *
@ -256,3 +258,5 @@ protected:
#endif #endif
#endif // MBED_CAN_H #endif // MBED_CAN_H
/** @}*/

View File

@ -22,6 +22,8 @@
#include "platform/critical.h" #include "platform/critical.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A digital input, used for reading the state of a pin /** A digital input, used for reading the state of a pin
* *
@ -113,3 +115,5 @@ protected:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -22,6 +22,8 @@
#include "platform/critical.h" #include "platform/critical.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A digital input/output, used for setting or reading a bi-directional pin /** A digital input/output, used for setting or reading a bi-directional pin
* *
@ -138,3 +140,5 @@ protected:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -21,6 +21,8 @@
#include "platform/critical.h" #include "platform/critical.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A digital output, used for setting the state of a pin /** A digital output, used for setting the state of a pin
* *
@ -124,3 +126,5 @@ protected:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -31,6 +31,8 @@ struct dirent {
}; };
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** Represents a directory stream. Objects of this type are returned /** Represents a directory stream. Objects of this type are returned
* by a FileSystemLike's opendir method. Implementations must define * by a FileSystemLike's opendir method. Implementations must define
@ -118,3 +120,5 @@ extern "C" {
}; };
#endif /* MBED_DIRHANDLE_H */ #endif /* MBED_DIRHANDLE_H */
/** @}*/

View File

@ -21,6 +21,8 @@
#if DEVICE_ETHERNET #if DEVICE_ETHERNET
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** An ethernet interface, to use with the ethernet pins. /** An ethernet interface, to use with the ethernet pins.
* *
@ -170,3 +172,5 @@ public:
#endif #endif
#endif #endif
/** @}*/

View File

@ -46,6 +46,8 @@ typedef long off_t;
#include "platform/PlatformMutex.h" #include "platform/PlatformMutex.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
typedef enum { typedef enum {
FilePathType, FilePathType,
@ -80,3 +82,5 @@ private:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -29,6 +29,8 @@ typedef long off_t;
#endif #endif
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** An OO equivalent of the internal FILEHANDLE variable /** An OO equivalent of the internal FILEHANDLE variable
* and associated _sys_* functions. * and associated _sys_* functions.
@ -138,3 +140,5 @@ protected:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -20,6 +20,8 @@
#include "drivers/FileHandle.h" #include "drivers/FileHandle.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/* Class FileLike /* Class FileLike
* A file-like object is one that can be opened with fopen by * A file-like object is one that can be opened with fopen by
@ -45,3 +47,5 @@ public:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -22,6 +22,8 @@
#include "drivers/FileLike.h" #include "drivers/FileLike.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
class FilePath { class FilePath {
public: public:
@ -44,3 +46,5 @@ private:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -23,6 +23,8 @@
#include "drivers/DirHandle.h" #include "drivers/DirHandle.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A filesystem-like object is one that can be used to open files /** A filesystem-like object is one that can be used to open files
* though it by fopen("/name/filename", mode) * though it by fopen("/name/filename", mode)
@ -104,3 +106,5 @@ public:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -31,6 +31,8 @@
#endif #endif
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** An I2C Master, used for communicating with I2C slave devices /** An I2C Master, used for communicating with I2C slave devices
* *
@ -191,3 +193,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -23,6 +23,8 @@
#include "hal/i2c_api.h" #include "hal/i2c_api.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** An I2C Slave, used for communicating with an I2C Master device /** An I2C Slave, used for communicating with an I2C Master device
* *
@ -154,3 +156,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -27,6 +27,8 @@
#include "platform/toolchain.h" #include "platform/toolchain.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A digital interrupt input, used to call a function on a rising or falling edge /** A digital interrupt input, used to call a function on a rising or falling edge
* *
@ -158,3 +160,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -22,6 +22,8 @@
#include <string.h> #include <string.h>
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** Use this singleton if you need to chain interrupt handlers. /** Use this singleton if you need to chain interrupt handlers.
* *
@ -169,3 +171,5 @@ private:
#endif #endif
/** @}*/

View File

@ -24,6 +24,8 @@
#include "platform/PlatformMutex.h" #include "platform/PlatformMutex.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
FILEHANDLE local_file_open(const char* name, int flags); FILEHANDLE local_file_open(const char* name, int flags);
@ -108,3 +110,5 @@ public:
#endif #endif
#endif #endif
/** @}*/

View File

@ -24,6 +24,8 @@
#include "hal/lp_ticker_api.h" #include "hal/lp_ticker_api.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** Low Power Ticker /** Low Power Ticker
* *
@ -44,3 +46,5 @@ public:
#endif #endif
#endif #endif
/** @}*/

View File

@ -24,6 +24,8 @@
#include "drivers/LowPowerTicker.h" #include "drivers/LowPowerTicker.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** Low Power Timout /** Low Power Timout
* *
@ -42,3 +44,5 @@ private:
#endif #endif
#endif #endif
/** @}*/

View File

@ -24,6 +24,8 @@
#include "hal/lp_ticker_api.h" #include "hal/lp_ticker_api.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** Low power timer /** Low power timer
* *
@ -42,3 +44,5 @@ public:
#endif #endif
#endif #endif
/** @}*/

View File

@ -24,6 +24,8 @@
#include "platform/critical.h" #include "platform/critical.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A multiple pin digital input /** A multiple pin digital input
* *
@ -98,3 +100,5 @@ private:
#endif #endif
#endif #endif
/** @}*/

View File

@ -24,6 +24,8 @@
#include "platform/critical.h" #include "platform/critical.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A multiple pin digital in/out used to set/read multiple bi-directional pins /** A multiple pin digital in/out used to set/read multiple bi-directional pins
* *
@ -113,3 +115,5 @@ private:
#endif #endif
#endif #endif
/** @}*/

View File

@ -24,6 +24,8 @@
#include "platform/critical.h" #include "platform/critical.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A multiple pin digital out /** A multiple pin digital out
* *
* @Note Synchronization level: Interrupt safe * @Note Synchronization level: Interrupt safe
@ -107,3 +109,5 @@ private:
#endif #endif
#endif #endif
/** @}*/

View File

@ -23,6 +23,8 @@
#include "platform/critical.h" #include "platform/critical.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A pulse-width modulation digital output /** A pulse-width modulation digital output
* *
@ -179,3 +181,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -24,6 +24,8 @@
#include "hal/serial_api.h" #include "hal/serial_api.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A serial port (UART) for communication with other serial devices /** A serial port (UART) for communication with other serial devices
* This is a variation of the Serial class that doesn't use streams, * This is a variation of the Serial class that doesn't use streams,
@ -101,3 +103,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -33,6 +33,8 @@
#endif #endif
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A SPI Master, used for communicating with SPI slave devices /** A SPI Master, used for communicating with SPI slave devices
* *
@ -259,3 +261,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -23,6 +23,8 @@
#include "hal/spi_api.h" #include "hal/spi_api.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A SPI slave, used for communicating with a SPI Master device /** A SPI slave, used for communicating with a SPI Master device
* *
@ -122,3 +124,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -26,6 +26,8 @@
#include "serial_api.h" #include "serial_api.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A serial port (UART) for communication with other serial devices /** A serial port (UART) for communication with other serial devices
* *
@ -93,3 +95,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -31,6 +31,8 @@
#endif #endif
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A base class for serial port implementations /** A base class for serial port implementations
* Can't be instantiated directly (use Serial or RawSerial) * Can't be instantiated directly (use Serial or RawSerial)
@ -256,3 +258,5 @@ protected:
#endif #endif
#endif #endif
/** @}*/

View File

@ -21,6 +21,8 @@
#include <cstdarg> #include <cstdarg>
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
extern void mbed_set_unbuffered_stream(FILE *_file); extern void mbed_set_unbuffered_stream(FILE *_file);
extern int mbed_getc(FILE *_file); extern int mbed_getc(FILE *_file);
@ -70,3 +72,5 @@ private:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -21,6 +21,8 @@
#include "platform/toolchain.h" #include "platform/toolchain.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A Ticker is used to call a function at a recurring interval /** A Ticker is used to call a function at a recurring interval
* *
@ -140,3 +142,5 @@ protected:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -19,6 +19,8 @@
#include "drivers/Ticker.h" #include "drivers/Ticker.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A Timeout is used to call a function at a point in the future /** A Timeout is used to call a function at a point in the future
* *
@ -59,3 +61,5 @@ protected:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -20,6 +20,8 @@
#include "hal/ticker_api.h" #include "hal/ticker_api.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** A general purpose timer /** A general purpose timer
* *
@ -91,3 +93,5 @@ protected:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -20,6 +20,8 @@
#include "hal/us_ticker_api.h" #include "hal/us_ticker_api.h"
namespace mbed { namespace mbed {
/** \addtogroup drivers */
/** @{*/
/** Base abstraction for timer interrupts /** Base abstraction for timer interrupts
* *
@ -56,3 +58,5 @@ protected:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -20,6 +20,8 @@
#include "platform/mbed_assert.h" #include "platform/mbed_assert.h"
namespace events { namespace events {
/** \addtogroup events */
/** @{*/
/** Event /** Event
* *
@ -3311,3 +3313,5 @@ Event<void(A0, A1, A2, A3, A4)> EventQueue::event(const volatile T *obj, R (T::*
} }
#endif #endif
/** @}*/

View File

@ -22,6 +22,8 @@
#include <new> #include <new>
namespace events { namespace events {
/** \addtogroup events */
/** @{*/
/** EVENTS_EVENT_SIZE /** EVENTS_EVENT_SIZE
* Minimum size of an event * Minimum size of an event
@ -2478,3 +2480,5 @@ protected:
} }
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup events */
/** @{*/
/* /*
* Flexible event queue for dispatching events * Flexible event queue for dispatching events
* *
@ -216,3 +219,5 @@ void equeue_chain(equeue_t *queue, equeue_t *target);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup events */
/** @{*/
/* /*
* System specific implementation * System specific implementation
* *
@ -138,3 +141,5 @@ bool equeue_sema_wait(equeue_sema_t *sema, int ms);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup events */
/** @{*/
/* events /* events
* Copyright (c) 2016 ARM Limited * Copyright (c) 2016 ARM Limited
* *
@ -31,3 +34,5 @@ using namespace events;
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
#ifndef GREENTEA_METRICS_H #ifndef GREENTEA_METRICS_H
#define GREENTEA_METRICS_H #define GREENTEA_METRICS_H
@ -12,3 +15,5 @@ void greentea_metrics_setup(void);
void greentea_metrics_report(void); void greentea_metrics_report(void);
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
#ifndef GREENTEA_SERIAL_H #ifndef GREENTEA_SERIAL_H
#define GREENTEA_SERIAL_H #define GREENTEA_SERIAL_H
@ -11,3 +14,5 @@ public:
extern SingletonPtr<GreenteaSerial> greentea_serial; extern SingletonPtr<GreenteaSerial> greentea_serial;
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
/* /*
* Copyright (c) 2013-2016, ARM Limited, All Rights Reserved * Copyright (c) 2013-2016, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -97,3 +100,5 @@ void greentea_notify_coverage_end();
#endif // MBED_CFG_DEBUG_OPTIONS_COVERAGE #endif // MBED_CFG_DEBUG_OPTIONS_COVERAGE
#endif // GREENTEA_CLIENT_TEST_ENV_H_ #endif // GREENTEA_CLIENT_TEST_ENV_H_
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
/* ========================================== /* ==========================================
Unity Project - A Test Framework for C Unity Project - A Test Framework for C
Copyright (c) 2007-14 Mike Karlesky, Mark VanderVoord, Greg Williams Copyright (c) 2007-14 Mike Karlesky, Mark VanderVoord, Greg Williams
@ -294,3 +297,5 @@ void tearDown(void);
} }
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
/**************************************************************************** /****************************************************************************
* Copyright (c) 2015, ARM Limited, All Rights Reserved * Copyright (c) 2015, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -36,3 +39,5 @@
#endif //UNITY_OUTPUT_CHAR #endif //UNITY_OUTPUT_CHAR
#endif // UNITY_CONFIG_H #endif // UNITY_CONFIG_H
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
/* ========================================== /* ==========================================
Unity Project - A Test Framework for C Unity Project - A Test Framework for C
Copyright (c) 2007-14 Mike Karlesky, Mark VanderVoord, Greg Williams Copyright (c) 2007-14 Mike Karlesky, Mark VanderVoord, Greg Williams
@ -779,3 +782,5 @@ extern const char UnityStrErr64[];
/* End of UNITY_INTERNALS_H */ /* End of UNITY_INTERNALS_H */
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
/**************************************************************************** /****************************************************************************
* Copyright (c) 2015, ARM Limited, All Rights Reserved * Copyright (c) 2015, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -38,3 +41,5 @@ void utest_safe_putc(int chr);
#endif #endif
#endif // UTEST_UNITY_ASSERT_FAILURE_H #endif // UTEST_UNITY_ASSERT_FAILURE_H
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
/**************************************************************************** /****************************************************************************
* Copyright (c) 2015, ARM Limited, All Rights Reserved * Copyright (c) 2015, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -26,3 +29,5 @@
#include "utest/utest_serial.h" #include "utest/utest_serial.h"
#endif // UTEST_H #endif // UTEST_H
/** @}*/

View File

@ -27,6 +27,8 @@
namespace utest { namespace utest {
/** \addtogroup frameworks */
/** @{*/
namespace v1 { namespace v1 {
/** Test case wrapper class. /** Test case wrapper class.
@ -127,3 +129,5 @@ namespace v1 {
} // namespace utest } // namespace utest
#endif // UTEST_CASES_H #endif // UTEST_CASES_H
/** @}*/

View File

@ -26,6 +26,8 @@
namespace utest { namespace utest {
/** \addtogroup frameworks */
/** @{*/
namespace v1 { namespace v1 {
/** Default handler hint. /** Default handler hint.
@ -191,3 +193,5 @@ namespace v1 {
} // namespace utest } // namespace utest
#endif // UTEST_DEFAULT_HANDLER_H #endif // UTEST_DEFAULT_HANDLER_H
/** @}*/

View File

@ -31,6 +31,8 @@
namespace utest { namespace utest {
/** \addtogroup frameworks */
/** @{*/
namespace v1 { namespace v1 {
/** Test Harness. /** Test Harness.
@ -99,3 +101,5 @@ namespace v1 {
} // namespace utest } // namespace utest
#endif // UTEST_HARNESS_H #endif // UTEST_HARNESS_H
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
/**************************************************************************** /****************************************************************************
* Copyright (c) 2015, ARM Limited, All Rights Reserved * Copyright (c) 2015, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -102,3 +105,5 @@ typedef struct {
#endif #endif
#endif // UTEST_SCHEDULER_H #endif // UTEST_SCHEDULER_H
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
/**************************************************************************** /****************************************************************************
* Copyright (c) 2016, ARM Limited, All Rights Reserved * Copyright (c) 2016, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -24,3 +27,5 @@
#define utest_printf(...) greentea_serial->printf(__VA_ARGS__) #define utest_printf(...) greentea_serial->printf(__VA_ARGS__)
#endif // UTEST_SERIAL_H #endif // UTEST_SERIAL_H
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
/**************************************************************************** /****************************************************************************
* Copyright (c) 2016, ARM Limited, All Rights Reserved * Copyright (c) 2016, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -85,3 +88,5 @@ utest_v1_scheduler_t utest_v1_get_scheduler(void);
#endif #endif
#endif // UTEST_SHIM_H #endif // UTEST_SHIM_H
/** @}*/

View File

@ -28,6 +28,8 @@
namespace utest { namespace utest {
/** \addtogroup frameworks */
/** @{*/
namespace v1 { namespace v1 {
/** Test specification containing the setup and teardown handlers and test cases. /** Test specification containing the setup and teardown handlers and test cases.
@ -137,3 +139,5 @@ namespace v1 {
} // namespace utest } // namespace utest
#endif // UTEST_SPECIFICATION_H #endif // UTEST_SPECIFICATION_H
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup frameworks */
/** @{*/
/**************************************************************************** /****************************************************************************
* Copyright (c) 2016, ARM Limited, All Rights Reserved * Copyright (c) 2016, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -42,3 +45,5 @@ extern void utest_dump_trace();
#endif // UTEST_STACK_TRACE #endif // UTEST_STACK_TRACE
#endif // UTEST_STACK_TRACE_H #endif // UTEST_STACK_TRACE_H
/** @}*/

View File

@ -26,6 +26,8 @@
#include "SingletonPtr.h" #include "SingletonPtr.h"
namespace utest { namespace utest {
/** \addtogroup frameworks */
/** @{*/
namespace v1 { namespace v1 {
enum repeat_t { enum repeat_t {
@ -402,3 +404,5 @@ namespace v1 {
} // namespace utest } // namespace utest
#endif // UTEST_TYPES_H #endif // UTEST_TYPES_H
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* CellularInterface /* CellularInterface
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -71,3 +74,5 @@ private:
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* EthInterface /* EthInterface
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -30,3 +33,5 @@ class EthInterface : public NetworkInterface
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* MeshInterface /* MeshInterface
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -30,3 +33,5 @@ class MeshInterface : public NetworkInterface
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* NetworkStack /* NetworkStack
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -154,3 +157,5 @@ protected:
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* NetworkStack /* NetworkStack
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -321,3 +324,5 @@ NetworkStack *nsapi_create_stack(IF *iface)
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* Socket /* Socket
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -197,3 +200,5 @@ protected:
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* SocketAddress /* SocketAddress
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -167,3 +170,5 @@ private:
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* TCPServer /* TCPServer
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -91,3 +94,5 @@ protected:
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* TCPSocket /* TCPSocket
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -122,3 +125,5 @@ protected:
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* UDPSocket /* UDPSocket
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -120,3 +123,5 @@ protected:
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* WiFiInterface /* WiFiInterface
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -90,3 +93,5 @@ private:
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* nsapi.h - The network socket API /* nsapi.h - The network socket API
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -42,3 +45,5 @@
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* nsapi_dns.h /* nsapi_dns.h
* Original work Copyright (c) 2013 Henry Leinen (henry[dot]leinen [at] online [dot] de) * Original work Copyright (c) 2013 Henry Leinen (henry[dot]leinen [at] online [dot] de)
* Modified work Copyright (c) 2015 ARM Limited * Modified work Copyright (c) 2015 ARM Limited
@ -176,3 +179,5 @@ static inline int nsapi_dns_add_server(const char *address)
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup netsocket */
/** @{*/
/* nsapi.h - The network socket API /* nsapi.h - The network socket API
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -454,3 +457,5 @@ typedef struct nsapi_stack_api
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -64,3 +67,5 @@ uint16_t analogin_read_u16(analogin_t *obj);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -86,3 +89,5 @@ uint16_t analogout_read_u16(dac_t *obj);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2014-2015 ARM Limited * Copyright (c) 2014-2015 ARM Limited
* *
@ -28,3 +31,5 @@ typedef struct buffer_s {
} buffer_t; } buffer_t;
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2016 ARM Limited * Copyright (c) 2006-2016 ARM Limited
* *
@ -78,3 +81,5 @@ void can_monitor (can_t *obj, int silent);
#endif // MBED_CAN_API_H #endif // MBED_CAN_API_H
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -51,3 +54,5 @@ typedef struct CAN_Message CAN_Message;
#endif #endif
#endif // MBED_CAN_HELPER_H #endif // MBED_CAN_HELPER_H
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2014-2015 ARM Limited * Copyright (c) 2014-2015 ARM Limited
* *
@ -43,3 +46,5 @@ int dma_channel_free(int channelid);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -61,3 +64,5 @@ void ethernet_set_link(int speed, int duplex);
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -126,3 +129,5 @@ void gpio_init_inout(gpio_t* gpio, PinName pin, PinDirection direction, PinMode
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -90,3 +93,5 @@ void gpio_irq_disable(gpio_irq_t *obj);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2015 ARM Limited * Copyright (c) 2006-2015 ARM Limited
* *
@ -239,3 +242,5 @@ void i2c_abort_asynch(i2c_t *obj);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -80,3 +83,5 @@ void lp_ticker_clear_interrupt(void);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -43,3 +46,5 @@ uint32_t pinmap_find_function(PinName pin, const PinMap* map);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -86,3 +89,5 @@ int port_read(port_t *obj);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -113,3 +116,5 @@ void pwmout_pulsewidth_us(pwmout_t *obj, int us);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -70,3 +73,5 @@ void rtc_write(time_t t);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -300,3 +303,5 @@ void serial_rx_abort_asynch(serial_t *obj);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -62,3 +65,5 @@ void deepsleep(void);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited * Copyright (c) 2006-2013 ARM Limited
* *
@ -212,3 +215,5 @@ void spi_abort_asynch(spi_t *obj);
#endif // SPI_DEVICE #endif // SPI_DEVICE
#endif // MBED_SPI_API_H #endif // MBED_SPI_API_H
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* /*
* Copyright (c) 2006-2016, ARM Limited, All Rights Reserved * Copyright (c) 2006-2016, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -51,3 +54,5 @@ typedef enum _ARM_POWER_STATE {
} ARM_POWER_STATE; } ARM_POWER_STATE;
#endif /* __DRIVER_COMMON_H */ #endif /* __DRIVER_COMMON_H */
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* /*
* Copyright (c) 2006-2016, ARM Limited, All Rights Reserved * Copyright (c) 2006-2016, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -766,3 +769,5 @@ typedef struct _ARM_DRIVER_STORAGE {
#endif // __cplusplus #endif // __cplusplus
#endif /* __DRIVER_STORAGE_H */ #endif /* __DRIVER_STORAGE_H */
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited
* *
@ -114,3 +117,5 @@ int ticker_get_next_timestamp(const ticker_data_t *const data, timestamp_t *time
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2016 ARM Limited * Copyright (c) 2016 ARM Limited
* *
@ -65,3 +68,5 @@ int trng_get_bytes(trng_t *obj, uint8_t *output, size_t length, size_t *output_l
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup hal */
/** @{*/
/* mbed Microcontroller Library /* mbed Microcontroller Library
* Copyright (c) 2006-2015 ARM Limited * Copyright (c) 2006-2015 ARM Limited
* *
@ -76,3 +79,5 @@ void us_ticker_clear_interrupt(void);
#endif #endif
#endif #endif
/** @}*/

View File

@ -1,3 +1,6 @@
/** \addtogroup platform */
/** @{*/
/* General C++ Object Thunking class /* General C++ Object Thunking class
* *
* - allows direct callbacks to non-static C++ class functions * - allows direct callbacks to non-static C++ class functions
@ -238,3 +241,5 @@ class CThunk
}; };
#endif/*__CTHUNK_H__*/ #endif/*__CTHUNK_H__*/
/** @}*/

View File

@ -21,6 +21,8 @@
#include <string.h> #include <string.h>
namespace mbed { namespace mbed {
/** \addtogroup platform */
/** @{*/
/** Group one or more functions in an instance of a CallChain, then call them in /** Group one or more functions in an instance of a CallChain, then call them in
* sequence using CallChain::call(). Used mostly by the interrupt chaining code, * sequence using CallChain::call(). Used mostly by the interrupt chaining code,
@ -186,3 +188,5 @@ private:
} // namespace mbed } // namespace mbed
#endif #endif
/** @}*/

View File

@ -23,6 +23,8 @@
#include "platform/toolchain.h" #include "platform/toolchain.h"
namespace mbed { namespace mbed {
/** \addtogroup platform */
/** @{*/
/** Callback class based on template specialization /** Callback class based on template specialization
@ -5926,3 +5928,5 @@ Callback<R(A0, A1, A2, A3, A4)> callback(const volatile T *obj, R (*func)(const
#endif #endif
/** @}*/

Some files were not shown because too many files have changed in this diff Show More