Skip to content

Commit aa80b55

Browse files
authored
Merge pull request #4233 from sg-/fix-the-docs2
[platform] Update doxygen comments
2 parents 0c2af26 + d503afc commit aa80b55

20 files changed

+173
-282
lines changed

doxygen_options.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"SEARCH_INCLUDES": "YES",
66
"INCLUDE_PATH": "",
77
"INCLUDE_FILE_PATTERNS": "",
8-
"PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\"",
8+
"PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\"",
99
"EXPAND_AS_DEFINED": "",
1010
"SKIP_FUNCTION_MACROS": "NO",
11-
"EXCLUDE_PATTERNS": "*/targets/* */features/FEATURE_*/* */features/mbedtls/* */features/nanostack/* */features/storage/* */features/unsupported/* */features/frameworks/* */features/filesystem/fat/* */BUILD/* */rtos/* */events/* */platform/* */cmsis/* */hal/* */features/*"
11+
"EXCLUDE_PATTERNS": "*/tools/* */TESTS/* */targets/* */features/FEATURE_*/* */features/mbedtls/* */features/nanostack/* */features/storage/* */features/unsupported/* */features/frameworks/* */features/filesystem/fat/* */BUILD/* */rtos/* */events/* */cmsis/* */hal/* */features/*"
1212
}

platform/CThunk.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ typedef void (*CThunkEntry)(void);
7777
/**
7878
* Class for created a pointer with data bound to it
7979
*
80-
* @Note Synchronization level: Not protected
80+
* @note Synchronization level: Not protected
8181
* @ingroup platform
8282
*/
8383
template<class T>

platform/CallChain.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ namespace mbed {
2727
* sequence using CallChain::call(). Used mostly by the interrupt chaining code,
2828
* but can be used for other purposes.
2929
*
30-
* @Note Synchronization level: Not protected
30+
* @note Synchronization level: Not protected
3131
*
3232
* Example:
3333
* @code
@@ -114,8 +114,8 @@ class CallChain {
114114

115115
/** Add a function at the beginning of the chain
116116
*
117-
* @param tptr pointer to the object to call the member function on
118-
* @param mptr pointer to the member function to be called
117+
* @param obj pointer to the object to call the member function on
118+
* @param method pointer to the member function to be called
119119
*
120120
* @returns
121121
* The function object created for 'tptr' and 'mptr'

0 commit comments

Comments
 (0)