From: bernie <bernie@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Wed, 13 Aug 2008 09:46:28 +0000 (+0000)
Subject: cpu/power.h: Documentation fixes
X-Git-Tag: 2.0.0~306
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=b812fafcc11015af6fe0ef2b1b0bd81e19cf6eff;p=bertos.git

cpu/power.h: Documentation fixes

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@1628 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/bertos/cpu/power.h b/bertos/cpu/power.h
index 04c06076..035495d4 100644
--- a/bertos/cpu/power.h
+++ b/bertos/cpu/power.h
@@ -52,7 +52,7 @@
  * Let the CPU rest in tight busy loops
  *
  * User code that sits in a busy loop should call cpu_relax() every
- * once in a while to perform system-depndent idle processing.
+ * once in a while to perform system-dependent idle processing.
  *
  * Depending on the system configuration, this might perform different
  * actions:
@@ -61,6 +61,8 @@
  *  - reset the watchdog timer to avoid it from triggering
  *  - scale the CPU speed down to save power (unimplemented)
  *  - let the event loop of the emulator process a few events
+ *
+ * \see proc_yield() cpu_pause()
  */
 INLINE void cpu_relax(void)
 {
@@ -90,10 +92,12 @@ INLINE void cpu_relax(void)
  *     IRQ_ENABLE();
  * \endcode
  *
- * \note Some implementations of cpu_pause() may return before any interrupt has occurred
- *       Caller code should be written taking this into account.
+ * \note Some implementations of cpu_pause() may return before any interrupt
+ *       has occurred.  Calling code should take this possibility into account.
  *
  * \note This function is currently unimplemented
+ *
+ * \see cpu_relax() cpu_yield()
  */
 INLINE void cpu_pause(void)
 {