aboutsummaryrefslogtreecommitdiff
path: root/libmaple/timer.h
diff options
context:
space:
mode:
authorMichael Hope <michaelh@juju.net.nz>2011-08-31 20:45:44 +1200
committerMichael Hope <michaelh@juju.net.nz>2011-09-13 19:35:12 +1200
commitb9be2450f0e3d39d234221ec301a319b79dcfb4e (patch)
tree0cd9a785f0491a823d38b3a6fb01fa48edbdfcfd /libmaple/timer.h
parent0697f5d0d61fd75c148df1ce91722608c789f0ac (diff)
Added more doxygen file level headers. Documented a few more functions.
Signed-off-by: Michael Hope <michaelh@juju.net.nz>
Diffstat (limited to 'libmaple/timer.h')
-rw-r--r--libmaple/timer.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/libmaple/timer.h b/libmaple/timer.h
index f142908..dfc8a4f 100644
--- a/libmaple/timer.h
+++ b/libmaple/timer.h
@@ -659,7 +659,8 @@ static inline uint16 timer_get_prescaler(timer_dev *dev) {
/**
* @brief Set a timer's prescale value.
*
- * The new value will not take effect until the next update event.
+ * Divides the input clock by (PSC+1). The new value will not take
+ * effect until the next update event.
*
* @param dev Timer whose prescaler to set
* @param psc New prescaler value