Diff: platform/mbed_toolchain.h

Revision:

170:19eb464bc2be

Parent:

169:e3b6fe271b81

Child:

176:447f873cad2f

--- a/platform/mbed_toolchain.h	Wed Jul 19 17:31:21 2017 +0100
+++ b/platform/mbed_toolchain.h	Thu Aug 03 13:13:39 2017 +0100
@@ -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.