From 1af21fad4997e72438d2c10114d97d7a5ada8572 Mon Sep 17 00:00:00 2001 From: Marti Bolivar Date: Wed, 16 Feb 2011 05:45:40 -0500 Subject: docs fixes --- docs/source/gpio.rst | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) (limited to 'docs/source/gpio.rst') diff --git a/docs/source/gpio.rst b/docs/source/gpio.rst index 4017862..cebb402 100644 --- a/docs/source/gpio.rst +++ b/docs/source/gpio.rst @@ -11,7 +11,7 @@ silkscreen. Many of these pins may additionally be used for special features or peripheral functions. This page documents those capabilities, by pin. -The current and voltage limitations have not been copied over from the +The current and voltage limitations have been copied over from the STM32 datasheet (see the :ref:`Recommended Reading ` for a link). In particular, a number of GPIO pins are 5V tolerant (which means that applying 5 volts to a pin @@ -31,6 +31,9 @@ peripheral type. The "STM32" column refers to the port and number that the header is connected to on the microcontroller. The "5V?" column documents whether or not the pin is 5 volt tolerant (see above). +.. TODO silkscreen pictures which let you know what each abbreviation +.. means, with links to the relevant documentation. + .. csv-table:: :header: "Pin", "STM32", ":ref:`ADC `", ":ref:`Timer `", ":ref:`I2C `", ":ref:`UART `", ":ref:`SPI `", "5v?" @@ -83,13 +86,17 @@ GPIO Modes Function Reference ------------------ -.. doxygenfunction:: pinMode +- :ref:`pinMode() ` + +- :ref:`digitalRead() ` -.. doxygenfunction:: digitalRead +- :ref:`digitalWrite() ` -.. doxygenfunction:: digitalWrite +- :ref:`analogRead() ` -.. doxygenfunction:: analogRead +- :ref:`pwmWrite() ` (Maple's equivalent to + ``analogWrite()``; see the :ref:`analogWrite() reference + ` for differences from the Arduino version). .. _gpio-recommended-reading: -- cgit v1.2.3