Diff: inc/core/MicroBitFiber.h

Revision:

41:da05ec75cd5d

Parent:

1:8aa5cdb4ab67

diff -r 948486a56c9d -r da05ec75cd5d inc/core/MicroBitFiber.h
--- a/inc/core/MicroBitFiber.h	Wed Jul 13 12:18:20 2016 +0100
+++ b/inc/core/MicroBitFiber.h	Wed Jul 13 12:18:21 2016 +0100
@@ -341,41 +341,16 @@
   * Adds a component to the array of idle thread components, which are processed
   * when the run queue is empty.
   *
-  * The system timer will poll isIdleCallbackNeeded on each component to determine
-  * if the scheduler should schedule the idle_task imminently.
-  *
   * @param component The component to add to the array.
-  *
   * @return MICROBIT_OK on success or MICROBIT_NO_RESOURCES if the fiber components array is full.
-  *
-  * @code
-  * MicroBitI2C i2c(I2C_SDA0, I2C_SCL0);
-  *
-  * // heap allocated - otherwise it will be paged out!
-  * MicroBitAccelerometer* accelerometer = new MicroBitAccelerometer(i2c);
-  *
-  * fiber_add_idle_component(accelerometer);
-  * @endcode
   */
 int fiber_add_idle_component(MicroBitComponent *component);
 
 /**
-  * Remove a component from the array of idle thread components
-  *
-  * @param component The component to remove from the idle component array.
-  *
-  * @return MICROBIT_OK on success. MICROBIT_INVALID_PARAMETER is returned if the given component has not been previously added.
+  * remove a component from the array of idle thread components
   *
-  * @code
-  * MicroBitI2C i2c(I2C_SDA0, I2C_SCL0);
-  *
-  * // heap allocated - otherwise it will be paged out!
-  * MicroBitAccelerometer* accelerometer = new MicroBitAccelerometer(i2c);
-  *
-  * fiber_add_idle_component(accelerometer);
-  *
-  * fiber_remove_idle_component(accelerometer);
-  * @endcode
+  * @param component the component to remove from the idle component array.
+  * @return MICROBIT_OK on success. MICROBIT_INVALID_PARAMETER is returned if the given component has not been previously added.
   */
 int fiber_remove_idle_component(MicroBitComponent *component);
 
@@ -398,4 +373,4 @@
 extern "C" void save_register_context(Cortex_M0_TCB *tcb);
 extern "C" void restore_register_context(Cortex_M0_TCB *tcb);
 
-#endif
+#endif
\ No newline at end of file