diff options
| author | Marti Bolivar <mbolivar@leaflabs.com> | 2011-06-11 19:25:29 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@leaflabs.com> | 2011-06-11 20:05:33 -0400 |
| commit | 0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch) | |
| tree | 3008ee192c80f17f640ebdeb870442e78415ce6b /wirish | |
| parent | d4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff) | |
| download | librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.tar.gz librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.zip | |
Remove reST documentation, attendant updates.
The documentation covers topics not specifically relevant to libmaple,
so it doesn't make sense for it to be part of the libmaple source
distribution.
Delete the docs/ tree, and prepare libmaple for use with the new
leaflabs-docs repo, which will contain the docs from now on.
* README: update to reflect this change
* support/doxygen/Doxyfile: This is the old docs/Doxyfile
* Makefile: Add a doxygen target
* wirish/comm/HardwareSerial.h: fix reference to docs/. The comment
informing maintainers that the HardwareSerial interface is
documented by hand refers to the docs/ tree, which no longer exists.
Update it to refer to the separate leaflabs-docs repository.
* support/scripts/copy-to-ide: No longer build the documentation
Diffstat (limited to 'wirish')
| -rw-r--r-- | wirish/comm/HardwareSerial.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/wirish/comm/HardwareSerial.h b/wirish/comm/HardwareSerial.h index dea1b1d..49d535d 100644 --- a/wirish/comm/HardwareSerial.h +++ b/wirish/comm/HardwareSerial.h @@ -40,15 +40,15 @@ /* * IMPORTANT: * - * This class documented "by hand" (i.e., not using Doxygen) in: - * - * libmaple/docs/source/lang/api/serial.rst + * This class documented "by hand" (i.e., not using Doxygen) in the + * leaflabs-docs/ repository. * * If you alter the public HardwareSerial interface, you MUST update * the documentation accordingly. */ -/* TODO [0.1.0] Document this here and make serial.rst use Breathe */ +/* TODO [0.1.0] Document this here and make leaflabs-docs' page use + * Breathe */ class HardwareSerial : public Print { public: |