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 #4508 from kegilbert/kg-doxygen-framework-hal-rtos 

Doxygen combined HAL, RTOS, and features/Framework updates to not produce warnings and errors [DOC Changes Only]
pull/4513/head
Sam Grove 2017-06-08 23:52:33 -05:00 committed by GitHub
parent 52fde55b6f 090e63f36a
commit 8e76bf6da6
11 changed files with 35 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doxyfile_options
View File

@ -840,14 +840,12 @@ EXCLUDE_PATTERNS = */tools/* \
*/TESTS/* \
*/targets/* \
*/BUILD/* \
*/rtos/* \
*/rtos/rtx* \
*/cmsis/* \
*/hal/* \
*/FEATURE_* \
*/features/mbedtls/* \
*/features/storage/* \
*/features/unsupported/* \
*/features/frameworks/* \
*/features/filesystem/* \
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

2
doxygen_options.json
View File

@ -8,5 +8,5 @@
"PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\"",
"EXPAND_AS_DEFINED": "",
"SKIP_FUNCTION_MACROS": "NO",
"EXCLUDE_PATTERNS": "*/tools/* */TESTS/* */targets/* */FEATURE_*/* */features/mbedtls/* */features/storage/* */features/unsupported/* */features/frameworks/* */features/filesystem/* */BUILD/* */rtos/* */cmsis/* */hal/* */features/FEATURES_*"
"EXCLUDE_PATTERNS": "*/tools/* */TESTS/* */targets/* */FEATURE_*/* */features/mbedtls/* */features/storage/* */features/unsupported/* */features/filesystem/* */BUILD/* */rtos/rtx*/* */cmsis/* */features/FEATURES_*"
}

2
features/frameworks/utest/utest/utest_case.h
View File

@ -36,7 +36,7 @@ namespace v1 {
*
* @warning Initialization of handlers with either default_handler or
* ignore_handler helpers will prevent the object to be a POD. Prefer usage
* of NULL in favor of ignore_handler or <handler_type>(1) for default
* of NULL in favor of ignore_handler or \verbatim <handler_type>(1) \endverbatim for default
* handler.
*
* @see Case.

8
features/frameworks/utest/utest/utest_default_handlers.h
View File

@ -38,6 +38,9 @@ namespace v1 {
*/
static const struct
{
///@cond IGNORE
// Doxygen can't parse these implicit conversion operators properly, remove from
// doc build
operator test_setup_handler_t() const { return test_setup_handler_t(1); }
operator test_teardown_handler_t() const { return test_teardown_handler_t(1); }
operator test_failure_handler_t() const { return test_failure_handler_t(1); }
@ -45,6 +48,7 @@ namespace v1 {
operator case_setup_handler_t() const { return case_setup_handler_t(1); }
operator case_teardown_handler_t() const { return case_teardown_handler_t(1); }
operator case_failure_handler_t() const { return case_failure_handler_t(1); }
///@endcond
} default_handler;
/** Ignore handler hint.
@ -55,6 +59,9 @@ namespace v1 {
*/
static const struct
{
///@cond IGNORE
// Doxygen can't parse these implicit conversion operators properly, remove from
// doc build
operator case_handler_t() const { return case_handler_t(NULL); }
operator case_control_handler_t() const { return case_control_handler_t(NULL); }
operator case_call_count_handler_t() const { return case_call_count_handler_t(NULL); }
@ -66,6 +73,7 @@ namespace v1 {
operator case_setup_handler_t() const { return case_setup_handler_t(NULL); }
operator case_teardown_handler_t() const { return case_teardown_handler_t(NULL); }
operator case_failure_handler_t() const { return case_failure_handler_t(NULL); }
///@endcond
} ignore_handler;
/** A table of handlers.

4
features/frameworks/utest/utest/utest_types.h
View File

@ -30,6 +30,7 @@ namespace utest {
/** @{*/
namespace v1 {
/// repeat_t
enum repeat_t {
REPEAT_UNDECLR = 0,
REPEAT_NONE = 1, ///< continue with the next test case
@ -47,12 +48,14 @@ namespace v1 {
REPEAT_HANDLER = REPEAT_CASE_ONLY | REPEAT_ON_VALIDATE ///< repeat only the handler
};
/// status_t
enum status_t {
STATUS_CONTINUE = -1, ///< continues testing
STATUS_IGNORE = -2, ///< ignores failure and continues testing
STATUS_ABORT = -3 ///< stops testing
};
/// failure_reason_t
enum failure_reason_t {
REASON_NONE = 0, ///< No failure occurred
@ -74,6 +77,7 @@ namespace v1 {
REASON_IGNORE = 0x8000 ///< The failure may be ignored
};
/// location_t
enum location_t {
LOCATION_NONE = 0, ///< No location information
LOCATION_TEST_SETUP, ///< A failure occurred in the test setup

20
hal/gpio_api.h
View File

@ -83,30 +83,30 @@ int gpio_read(gpio_t *obj);
/** Init the input pin and set mode to PullDefault
*
* @param obj The GPIO object
* @param pin The pin name
* @param gpio The GPIO object
* @param pin The pin name
*/
void gpio_init_in(gpio_t* gpio, PinName pin);
/** Init the input pin and set the mode
*
* @param obj The GPIO object
* @param pin The pin name
* @param mode The pin mode to be set
* @param gpio The GPIO object
* @param pin The pin name
* @param mode The pin mode to be set
*/
void gpio_init_in_ex(gpio_t* gpio, PinName pin, PinMode mode);
/** Init the output pin as an output, with predefined output value 0
*
* @param obj The GPIO object
* @param pin The pin name
* @return An integer value 1 or 0
* @param gpio The GPIO object
* @param pin The pin name
* @return An integer value 1 or 0
*/
void gpio_init_out(gpio_t* gpio, PinName pin);
/** Init the pin as an output and set the output value
*
* @param obj The GPIO object
* @param gpio The GPIO object
* @param pin The pin name
* @param value The value to be set
*/
@ -114,7 +114,7 @@ void gpio_init_out_ex(gpio_t* gpio, PinName pin, int value);
/** Init the pin to be in/out
*
* @param obj The GPIO object
* @param gpio The GPIO object
* @param pin The pin name
* @param direction The pin direction to be set
* @param mode The pin mode to be set

6
hal/storage_abstraction/Driver_Storage.h
View File

@ -615,9 +615,9 @@ typedef struct _ARM_DRIVER_STORAGE {
*
* This optional function erases the complete device. If the device does not
* support global erase then the function returns the error value \ref
* ARM_DRIVER_ERROR_UNSUPPORTED. The data field \em 'erase_all' =
* \token{1} of the structure \ref ARM_STORAGE_CAPABILITIES encodes that
* \ref ARM_STORAGE_EraseAll is supported.
* ARM_DRIVER_ERROR_UNSUPPORTED. The data field \em 'erase_all' = 1
* of the structure \ref ARM_STORAGE_CAPABILITIES encodes that
* ARM_STORAGE_EraseAll is supported.
*
* @note This API may execute asynchronously if
* ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. Asynchronous

3
hal/ticker_api.h
View File

@ -163,7 +163,8 @@ us_timestamp_t ticker_read_us(const ticker_data_t *const ticker);
/** Read the next event's timestamp
*
* @param ticker The ticker object.
* @param ticker The ticker object.
* @param timestamp The timestamp object.
* @return 1 if timestamp is pending event, 0 if there's no event pending
*/
int ticker_get_next_timestamp(const ticker_data_t *const ticker, timestamp_t *timestamp);

4
rtos/MemoryPool.h
View File

@ -76,8 +76,8 @@ public:
}
/** Free a memory block.
@param address of the allocated memory block to be freed.
@return status code that indicates the execution status of the function.
@param block address of the allocated memory block to be freed.
@return status code that indicates the execution status of the function.
*/
osStatus free(T *block) {
return osMemoryPoolFree(_id, (void*)block);

2
rtos/Semaphore.h
View File

@ -40,7 +40,7 @@ namespace rtos {
class Semaphore {
public:
/** Create and Initialize a Semaphore object used for managing resources.
@param number of available resources; maximum index value is (count-1). (default: 0).
@param count number of available resources; maximum index value is (count-1). (default: 0).
*/
Semaphore(int32_t count=0);

7
rtos/Thread.h
View File

@ -85,7 +85,6 @@ public:
/** Create a new thread, and start it executing the specified function.
@param task function to be executed by this thread.
@param argument pointer that is passed to the thread function as start argument. (default: NULL).
@param priority initial priority of the thread function. (default: osPriorityNormal).
@param stack_size stack size (in bytes) requirements for the thread function. (default: OS_STACK_SIZE).
@param stack_mem pointer to the stack area to be used by this thread (default: NULL).
@ -112,9 +111,8 @@ public:
}
/** Create a new thread, and start it executing the specified function.
@param obj argument to task.
@param method function to be executed by this thread.
@param argument pointer that is passed to the thread function as start argument. (default: NULL).
@param task argument to task.
@param priority initial priority of the thread function. (default: osPriorityNormal).
@param stack_size stack size (in bytes) requirements for the thread function. (default: OS_STACK_SIZE).
@param stack_mem pointer to the stack area to be used by this thread (default: NULL).
@ -143,9 +141,8 @@ public:
}
/** Create a new thread, and start it executing the specified function.
@param obj argument to task.
@param method function to be executed by this thread.
@param argument pointer that is passed to the thread function as start argument. (default: NULL).
@param task argument to task.
@param priority initial priority of the thread function. (default: osPriorityNormal).
@param stack_size stack size (in bytes) requirements for the thread function. (default: OS_STACK_SIZE).
@param stack_mem pointer to the stack area to be used by this thread (default: NULL).