ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Toolchain: Added a note about weak functions and header files 

The subtlety of where to mark functions as weak created an issue for
at least one user, so added a warning in the documentation.
pull/4718/head
Christopher Haster 2017-07-06 11:58:19 -05:00
parent e0f56d1ab7
commit eb4c223dd7
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
platform/mbed_toolchain.h
View File

@ -94,9 +94,15 @@
/** MBED_WEAK
* Mark a function as being weak.
*
* @note
* Functions should only be marked as weak in the source file. The header file
* should contain a regular function declaration to insure the function is emitted.
* A function marked weak will not be emitted if an alternative non-weak
* implementation is defined.
*
* @note
* weak functions are not friendly to making code re-usable, as they can only
* Weak functions are not friendly to making code re-usable, as they can only
* be overridden once (and if they are multiply overridden the linker will emit
* no warning). You should not normally use weak symbols as part of the API to
* re-usable modules.