aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/cpp/include.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 19:25:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 20:05:33 -0400
commit0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/lang/cpp/include.rst
parentd4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff)
downloadlibrambutan-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 'docs/source/lang/cpp/include.rst')
-rw-r--r--docs/source/lang/cpp/include.rst70
1 files changed, 0 insertions, 70 deletions
diff --git a/docs/source/lang/cpp/include.rst b/docs/source/lang/cpp/include.rst
deleted file mode 100644
index 163509d..0000000
--- a/docs/source/lang/cpp/include.rst
+++ /dev/null
@@ -1,70 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-include:
-
-``#include``
-============
-
-``#include`` is used to include outside libraries in your sketch.
-This gives the programmer access to a large group of standard C
-libraries (groups of pre-made functions and data types), and also
-libraries written especially for Maple.
-
-Example
--------
-
-This example (from the `Arduino LiquidCrystal Tutorial
-<http://arduino.cc/en/Tutorial/LiquidCrystal>`_) includes a library
-that is used to control :ref:`LCD displays
-<libraries-liquid-crystal>`::
-
- // include the library code:
- #include <LiquidCrystal.h>
-
- // initialize the library with the numbers of the interface pins
- LiquidCrystal lcd(12, 11, 5, 4, 3, 2);
-
- void setup() {
- // set up the LCD's number of columns and rows:
- lcd.begin(16, 2);
- // Print a message to the LCD.
- lcd.print("hello, world!");
- }
-
- void loop() {
- // set the cursor to column 0, line 1
- // (note: line 1 is the second row, since counting begins with 0):
- lcd.setCursor(0, 1);
- // print the number of seconds since reset:
- lcd.print(millis()/1000);
- }
-
-Note that a ``#include`` line, like :ref:`#define <lang-define>`,
-has **no semicolon**. The compiler will print strange error messages
-if you add one.
-
-C Standard Library
-------------------
-
-The standard C library that comes with Maple is called `newlib
-<http://sourceware.org/newlib/>`_. Its main sources of documentation
-are its `main reference <http://sourceware.org/newlib/libc.html>`_
-page and its `math functions
-<http://sourceware.org/newlib/libm.html>`_ reference page. Here's an
-example that imports the math.h library in order to take the `cube
-root <http://en.wikipedia.org/wiki/Cube_root>`_ of a number::
-
- #include <math.h>
-
- void setup() {
- // no setup necessary
- }
-
- void loop() {
- // "cbrt" stands for "cube root"
- double cubeRootOf3 = cbrt(3.0);
- // prints a number that is approximately the cube root of 3:
- SerialUSB.println(cubeRootOf3);
- }
-
-.. include:: /arduino-cc-attribution.txt