aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-05-17 17:51:03 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-05-19 15:03:21 -0400
commit6c06df1ca4227bc47414a3823bab8d49955b1226 (patch)
treefa33471377466f205250309b904526c265cd5585
parent5ac213a9e53ead0605dec6b78d58570cd2fad4b6 (diff)
downloadlibrambutan-6c06df1ca4227bc47414a3823bab8d49955b1226.tar.gz
librambutan-6c06df1ca4227bc47414a3823bab8d49955b1226.zip
delay.h: Adding Doxygen comments for the file and delay_us().
-rw-r--r--libmaple/delay.h12
1 files changed, 11 insertions, 1 deletions
diff --git a/libmaple/delay.h b/libmaple/delay.h
index 5372ac1..03d5c1e 100644
--- a/libmaple/delay.h
+++ b/libmaple/delay.h
@@ -1,10 +1,20 @@
/**
- * @brief Delay implementation
+ * @file delay.h
+ * @brief Delay implementation
*/
#ifndef _DELAY_H_
#define _DELAY_H_
+/**
+ * @brief Delay the given number of microseconds.
+ *
+ * Note that this function currently assumes you are on a LeafLabs
+ * board, and will only work properly if you follow the LeafLabs RCC
+ * configuration.
+ *
+ * @param us Number of microseconds to delay.
+ */
static inline void delay_us(uint32 us) {
/* TODO this makes unwarranted assumptions about the RCC
* config; add a hook so users can make their own decisions. */