aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/hardwaretimer.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/lang/api/hardwaretimer.rst')
-rw-r--r--docs/source/lang/api/hardwaretimer.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/source/lang/api/hardwaretimer.rst b/docs/source/lang/api/hardwaretimer.rst
index 3e5424c..c7a630d 100644
--- a/docs/source/lang/api/hardwaretimer.rst
+++ b/docs/source/lang/api/hardwaretimer.rst
@@ -21,6 +21,9 @@ documented below on one of the predefined ``HardwareTimer`` instances.
For example, to set the prescale factor on timer 1 to 5, call
``Timer1.setPrescaleFactor(5)``.
+.. TODO add code examples that people can copy and paste in case
+.. they're unfamiliar with namespace syntax
+
.. cpp:class:: HardwareTimer
Class for interacting with a timer. There are four predefined