From 5a7dd1bea32458a4afc038984a903959134b82d3 Mon Sep 17 00:00:00 2001
From: Hanna Mendes Levitin <hanna@anomaly-3.local>
Date: Wed, 1 Dec 2010 03:37:07 -0600
Subject: docs, now with style

---
 source/lang/api/micros.rst | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 source/lang/api/micros.rst

(limited to 'source/lang/api/micros.rst')

diff --git a/source/lang/api/micros.rst b/source/lang/api/micros.rst
new file mode 100644
index 0000000..f12976b
--- /dev/null
+++ b/source/lang/api/micros.rst
@@ -0,0 +1,46 @@
+.. highlight:: cpp
+
+.. _lang-micros:
+
+micros()
+========
+
+Returns the number of microseconds since the Maple board began running
+the current program. This number will overflow (go back to zero),
+after approximately 70 minutes.
+
+.. note:: There are 1,000 microseconds in a millisecond, and 1,000,000
+   microseconds in a second.
+
+Library Documentation
+---------------------
+
+.. doxygenfunction:: micros
+
+Example
+-------
+
+::
+
+    unsigned int time;
+
+    void setup() {
+    }
+
+    void loop() {
+      SerialUSB.print("Time: ");
+      time = micros();
+      // prints time since program started
+      SerialUSB.println(time);
+      // wait a second so as not to send massive amounts of data
+      delay(1000);
+    }
+
+See Also
+--------
+
+-  :ref:`millis() <lang-millis>`
+-  :ref:`delay() <lang-delay>`
+-  :ref:`delayMicroseconds() <lang-delaymicroseconds>`
+
+.. include:: cc-attribution.txt
-- 
cgit v1.2.3