aboutsummaryrefslogtreecommitdiffstats
path: root/wirish
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-04-12 00:08:54 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-04-12 00:08:54 -0400
commit7b14b950363f707c40732b4387f2f50711907673 (patch)
tree3833be4ef90981e72c9b4bf1bb848fc12b3bf783 /wirish
parentd3949203fe053249d35e0c4125f3ed21818e8c32 (diff)
downloadlibrambutan-7b14b950363f707c40732b4387f2f50711907673.tar.gz
librambutan-7b14b950363f707c40732b4387f2f50711907673.zip
Doxygen bugfixes.
Fixed various Doxygen comment errors.
Diffstat (limited to 'wirish')
-rw-r--r--wirish/pwm.h3
-rw-r--r--wirish/wirish_time.h2
-rw-r--r--wirish/wirish_types.h3
3 files changed, 7 insertions, 1 deletions
diff --git a/wirish/pwm.h b/wirish/pwm.h
index a6385e9..4ce4bb4 100644
--- a/wirish/pwm.h
+++ b/wirish/pwm.h
@@ -43,6 +43,9 @@
*
* User code is expected to determine and honor the maximum value
* (based on the configured period).
+ *
+ * @param pin PWM output pin
+ * @param duty_cycle Duty cycle to set.
*/
void pwmWrite(uint8 pin, uint16 duty_cycle);
diff --git a/wirish/wirish_time.h b/wirish/wirish_time.h
index a0c0c82..a0b1c11 100644
--- a/wirish/wirish_time.h
+++ b/wirish/wirish_time.h
@@ -23,7 +23,7 @@
*****************************************************************************/
/**
- * @file time.h
+ * @file wirish_time.h
* @brief Timing and delay functions.
*/
diff --git a/wirish/wirish_types.h b/wirish/wirish_types.h
index 475f470..39efae0 100644
--- a/wirish/wirish_types.h
+++ b/wirish/wirish_types.h
@@ -57,6 +57,9 @@ typedef struct stm32_pin_info {
uint8 adc_channel; /**< Pin ADC channel, or ADCx if none. */
} stm32_pin_info;
+/**
+ * Variable attribute, instructs the linker to place the marked
+ * variable in Flash instead of RAM. */
#define __FLASH__ __attr_flash
#endif