aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-04-01 13:14:47 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-04-01 13:14:47 +0000
commit01b0220ffa200db034b0be6b0f464ec3344e3c15 (patch)
tree360c826ee513c93c0ba9f162ccaec33f98a8fed7
parentd8420eb83a4b843ad23d0fbe77fea36272adc525 (diff)
downloadChibiOS-01b0220ffa200db034b0be6b0f464ec3344e3c15.tar.gz
ChibiOS-01b0220ffa200db034b0be6b0f464ec3344e3c15.tar.bz2
ChibiOS-01b0220ffa200db034b0be6b0f464ec3344e3c15.zip
Documentation related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2862 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--os/hal/include/icu.h4
-rw-r--r--os/hal/include/pwm.h1
-rw-r--r--os/hal/platforms/STM32/pwm_lld.c1
-rw-r--r--os/hal/src/pwm.c1
-rw-r--r--os/hal/templates/pwm_lld.c1
5 files changed, 6 insertions, 2 deletions
diff --git a/os/hal/include/icu.h b/os/hal/include/icu.h
index 8a89281ae..38fed2788 100644
--- a/os/hal/include/icu.h
+++ b/os/hal/include/icu.h
@@ -126,7 +126,7 @@ typedef void (*icucallback_t)(ICUDriver *icup);
*
* @notapi
*/
-#define _icu_isr_invoke_width_cb(usbp) { \
+#define _icu_isr_invoke_width_cb(icup) { \
(icup)->state = ICU_IDLE; \
(icup)->config->width_cb(icup); \
}
@@ -138,7 +138,7 @@ typedef void (*icucallback_t)(ICUDriver *icup);
*
* @notapi
*/
-#define _icu_isr_invoke_period_cb(usbp) { \
+#define _icu_isr_invoke_period_cb(icup) { \
icustate_t previous_state = (icup)->state; \
(icup)->state = ICU_ACTIVE; \
if (previous_state != ICU_WAITING) \
diff --git a/os/hal/include/pwm.h b/os/hal/include/pwm.h
index 7181054e4..76c2e1674 100644
--- a/os/hal/include/pwm.h
+++ b/os/hal/include/pwm.h
@@ -137,6 +137,7 @@ typedef void (*pwmcallback_t)(PWMDriver *pwmp);
* or immediately (fallback implementation).
*
* @param[in] pwmp pointer to a @p PWMDriver object
+ * @param[in] period new cycle time in ticks
*
* @iclass
*/
diff --git a/os/hal/platforms/STM32/pwm_lld.c b/os/hal/platforms/STM32/pwm_lld.c
index 2f125b345..15d54b4fd 100644
--- a/os/hal/platforms/STM32/pwm_lld.c
+++ b/os/hal/platforms/STM32/pwm_lld.c
@@ -530,6 +530,7 @@ void pwm_lld_stop(PWMDriver *pwmp) {
* @note The function has effect at the next cycle start.
*
* @param[in] pwmp pointer to a @p PWMDriver object
+ * @param[in] period new cycle time in ticks
*
* @api
*/
diff --git a/os/hal/src/pwm.c b/os/hal/src/pwm.c
index eaa49bc56..ed80ec24b 100644
--- a/os/hal/src/pwm.c
+++ b/os/hal/src/pwm.c
@@ -131,6 +131,7 @@ void pwmStop(PWMDriver *pwmp) {
* or immediately (fallback implementation).
*
* @param[in] pwmp pointer to a @p PWMDriver object
+ * @param[in] period new cycle time in ticks
*
* @api
*/
diff --git a/os/hal/templates/pwm_lld.c b/os/hal/templates/pwm_lld.c
index 295b0dcb4..2cd92422f 100644
--- a/os/hal/templates/pwm_lld.c
+++ b/os/hal/templates/pwm_lld.c
@@ -99,6 +99,7 @@ void pwm_lld_stop(PWMDriver *pwmp) {
* or immediately (fallback implementation).
*
* @param[in] pwmp pointer to a @p PWMDriver object
+ * @param[in] period new cycle time in ticks
*
* @api
*/