From 385351abd839219df1151a201a35ecfe7463f354 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Thu, 6 Jan 2011 09:07:01 +0000
Subject: [PATCH] Small documentation related fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/branches/stable_2.0.x@2586 35acf78f-673a-0410-8e92-d51de3d6d3f4
---
 os/hal/platforms/STM32/pwm_lld.h | 7 +------
 os/hal/templates/pwm_lld.h       | 7 +------
 os/various/ch.hpp                | 3 ++-
 test/test.c                      | 3 +++
 4 files changed, 7 insertions(+), 13 deletions(-)

diff --git a/os/hal/platforms/STM32/pwm_lld.h b/os/hal/platforms/STM32/pwm_lld.h
index 4a7865a31..e3e76e79b 100644
--- a/os/hal/platforms/STM32/pwm_lld.h
+++ b/os/hal/platforms/STM32/pwm_lld.h
@@ -264,11 +264,10 @@ struct PWMDriver {
  *          proper hardware resolution by carefully choosing the clock source
  *          and prescaler settings, see @p PWM_COMPUTE_PSC.
  *
+ * @param[in] pwmp      pointer to a @p PWMDriver object
  * @param[in] numerator numerator of the fraction
  * @param[in] denominator percentage as an integer between 0 and numerator
  * @return              The pulse width to be passed to @p pwmEnableChannel().
- *
- * @api
  */
 #define PWM_FRACTION_TO_WIDTH(pwmp, numerator, denominator)                 \
   ((uint16_t)((((uint32_t)(pwmp)->pd_config->pc_arr + 1UL) *                \
@@ -284,8 +283,6 @@ struct PWMDriver {
  * @param[in] pwmp      pointer to a @p PWMDriver object
  * @param[in] degrees   degrees as an integer between 0 and 36000
  * @return              The pulse width to be passed to @p pwmEnableChannel().
- *
- * @api
  */
 #define PWM_DEGREES_TO_WIDTH(pwmp, degrees)                                 \
   PWM_FRACTION_TO_WIDTH(pwmp, 36000, degrees)
@@ -300,8 +297,6 @@ struct PWMDriver {
  * @param[in] pwmp      pointer to a @p PWMDriver object
  * @param[in] percentage percentage as an integer between 0 and 10000
  * @return              The pulse width to be passed to @p pwmEnableChannel().
- *
- * @api
  */
 #define PWM_PERCENTAGE_TO_WIDTH(pwmp, percentage)                           \
   PWM_FRACTION_TO_WIDTH(pwmp, 10000, percentage)
diff --git a/os/hal/templates/pwm_lld.h b/os/hal/templates/pwm_lld.h
index 8605c3d8c..1b8eaec64 100644
--- a/os/hal/templates/pwm_lld.h
+++ b/os/hal/templates/pwm_lld.h
@@ -151,11 +151,10 @@ struct PWMDriver {
  *          proper hardware resolution by carefully choosing the clock source
  *          and prescaler settings, see @p PWM_COMPUTE_PSC.
  *
+ * @param[in] pwmp      pointer to a @p PWMDriver object
  * @param[in] numerator numerator of the fraction
  * @param[in] denominator percentage as an integer between 0 and numerator
  * @return              The pulse width to be passed to @p pwmEnableChannel().
- *
- * @api
  */
 #define PWM_FRACTION_TO_WIDTH(pwmp, numerator, denominator) 0
 
@@ -169,8 +168,6 @@ struct PWMDriver {
  * @param[in] pwmp      pointer to a @p PWMDriver object
  * @param[in] degrees   degrees as an integer between 0 and 36000
  * @return              The pulse width to be passed to @p pwmEnableChannel().
- *
- * @api
  */
 #define PWM_DEGREES_TO_WIDTH(pwmp, degrees)                                 \
   PWM_FRACTION_TO_WIDTH(pwmp, 36000, degrees)
@@ -185,8 +182,6 @@ struct PWMDriver {
  * @param[in] pwmp      pointer to a @p PWMDriver object
  * @param[in] percentage percentage as an integer between 0 and 10000
  * @return              The pulse width to be passed to @p pwmEnableChannel().
- *
- * @api
  */
 #define PWM_PERCENTAGE_TO_WIDTH(pwmp, percentage)                           \
   PWM_FRACTION_TO_WIDTH(pwmp, 10000, percentage)
diff --git a/os/various/ch.hpp b/os/various/ch.hpp
index 41cbd7f7b..0d797c699 100644
--- a/os/various/ch.hpp
+++ b/os/various/ch.hpp
@@ -69,8 +69,9 @@ namespace chibios_rt {
 
     /**
      * @brief Returns the system time as system ticks.
-     *
      * @note the system tick time interval is implementation dependent.
+     *
+     * @return          The system time.
      */
     static systime_t GetTime(void);
   };
diff --git a/test/test.c b/test/test.c
index 5b3040ba7..b39538360 100644
--- a/test/test.c
+++ b/test/test.c
@@ -250,6 +250,8 @@ void test_cpu_pulse(unsigned duration) {
 
 /**
  * @brief Delays execution until next system time tick.
+ *
+ * @return              The system time.
  */
 systime_t test_wait_tick(void) {
 
@@ -319,6 +321,7 @@ static void print_line(void) {
  * @brief   Test execution thread function.
  *
  * @param[in] p         pointer to a @p BaseChannel object for test output
+ * @return              A failure boolean value.
  */
 msg_t TestThread(void *p) {
   int i, j;