aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2014-08-28 16:37:17 -0400
committerbnewbold <bnewbold@robocracy.org>2014-08-28 16:37:19 -0400
commit3a24a1139bb699234cd66f7aaef6572edf70974d (patch)
tree703cf6e0a7131bc84fe6009cdd92608dcf5c75d1 /docs
parent055ee2124e380759a8c57e424039dd07e8729514 (diff)
downloadlibrambutan-3a24a1139bb699234cd66f7aaef6572edf70974d.tar.gz
librambutan-3a24a1139bb699234cd66f7aaef6572edf70974d.zip
docs: HACK workaround for 'DAC' doxygen problem
Tried adding STM32_HAVE_DAC=1 to the PREDEFINED list in support/doxygen/Doxyfile as per mbolivar's suggestion, but the DAC variable still doesn't make it's way into the doxygen output the way ADC1 et al are. So for now we'll just call that variable "undocumented" in the sphinx output and mark it as TODO.
Diffstat (limited to 'docs')
-rw-r--r--docs/source/libmaple/api/dac.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/source/libmaple/api/dac.rst b/docs/source/libmaple/api/dac.rst
index 55c8faf..4e9eb56 100644
--- a/docs/source/libmaple/api/dac.rst
+++ b/docs/source/libmaple/api/dac.rst
@@ -18,7 +18,10 @@ Types
Devices
-------
-.. doxygenvariable:: DAC
+.. TODO: This device doesn't get compiled in correctly yet
+ .. doxygenvariable:: DAC
+
+The ``DAC`` device is so-far undocumented.
Functions
---------