aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/cpp/enum.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/enum.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/enum.rst')
-rw-r--r--docs/source/lang/cpp/enum.rst52
1 files changed, 0 insertions, 52 deletions
diff --git a/docs/source/lang/cpp/enum.rst b/docs/source/lang/cpp/enum.rst
deleted file mode 100644
index b6409eb..0000000
--- a/docs/source/lang/cpp/enum.rst
+++ /dev/null
@@ -1,52 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-enum:
-
-``enum``
-========
-
-The ``enum`` keyword is used to specify an enumeration type. An
-enumeration type is a type whose values are taken from a specified,
-fixed list of constant values.
-
-Example
--------
-
-Here's an example defining an enumeration type called ``weather``,
-which has values ``HOT``, ``COMFY``, and ``COLD``::
-
- enum weather {HOT, COMFY, COLD};
-
-Once you've defined this type, you can create variables of type
-``weather``, in the same way you would with an :ref:`int <lang-int>`::
-
- // create a weather variable named theWeather, with value COMFY:
- weather theWeather = COMFY;
-
-Enumeration types are useful within :ref:`switch statements
-<lang-switchcase>`. If you know that an argument is of an enumeration
-type, you can make ``case`` statements for all of that type's possible
-values, so you know you won't miss anything::
-
- void describeWeather(weather currentWeather) {
- switch(currentWeather) {
- case HOT:
- SerialUSB.println("it's hot out");
- break;
- case COMFY:
- SerialUSB.println("it's nice today");
- break;
- case COLD:
- SerialUSB.println("it's freezing!");
- break;
- }
- }
-
-Such a ``switch`` statement would need no :ref:`default
-<lang-switchcase-default>`, since we know that ``currentWeather`` must
-be either ``HOT``, ``COMFY``, or ``COLD``.
-
-See Also
---------
-
-- :ref:`lang-switchcase`