Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[platform] Update doxygen comments #4233

Merged
merged 13 commits into from
May 4, 2017
Merged

[platform] Update doxygen comments #4233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5e7ce5f
[platform] Update doxygen errors from @Note to @note
sg- Apr 25, 2017
93b8bb8
[platform] Fix doxygen error @Return to @return
sg- Apr 25, 2017
6062ca7
[platform] Update doxygen errors with example code comments
sg- Apr 26, 2017
dcbb6f6
[platform] fix doxygen group close
sg- Apr 26, 2017
75e5b65
[platform] Fix doxygen errors in mbed_mem_trace.h
sg- Apr 26, 2017
4e417eb
[platform] fix doxygen preprocessor constant expresison warnings
sg- Apr 26, 2017
f5d598f
[platform] update incorrect doxygen tag for return documentation
sg- Apr 26, 2017
33e1d66
[platform] Remove stale doxygen parameter that doesnt exist in code
sg- Apr 26, 2017
5b580f6
[platform] Fix documentation error between argument names and @param
sg- Apr 26, 2017
6c65a0a
[platform] Fix undocumented parameters and fix parameters that didnt
sg- Apr 26, 2017
6c0a757
Allow the docs site to build doxygen in the mbed-os/platform directory
sg- Apr 26, 2017
8705305
callback: Moved out sfinae logic into a macro
geky Apr 28, 2017
d503afc
[doxygen] Exclude tools and TESTS directories. Add macro
sg- May 2, 2017
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
4 changes: 2 additions & 2 deletions doxygen_options.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"SEARCH_INCLUDES": "YES",
"INCLUDE_PATH": "",
"INCLUDE_FILE_PATTERNS": "",
"PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\"",
"PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\"",
"EXPAND_AS_DEFINED": "",
"SKIP_FUNCTION_MACROS": "NO",
"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/*"
"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/*"
}
2 changes: 1 addition & 1 deletion platform/CThunk.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ typedef void (*CThunkEntry)(void);
/**
* Class for created a pointer with data bound to it
*
* @Note Synchronization level: Not protected
* @note Synchronization level: Not protected
* @ingroup platform
*/
template<class T>
Expand Down
6 changes: 3 additions & 3 deletions platform/CallChain.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace mbed {
* sequence using CallChain::call(). Used mostly by the interrupt chaining code,
* but can be used for other purposes.
*
* @Note Synchronization level: Not protected
* @note Synchronization level: Not protected
*
* Example:
* @code
Expand Down Expand Up @@ -114,8 +114,8 @@ class CallChain {

/** Add a function at the beginning of the chain
*
* @param tptr pointer to the object to call the member function on
* @param mptr pointer to the member function to be called
* @param obj pointer to the object to call the member function on
* @param method pointer to the member function to be called
*
* @returns
* The function object created for 'tptr' and 'mptr'
Expand Down
Loading