aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/cpp/comments.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/comments.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/comments.rst')
-rw-r--r--docs/source/lang/cpp/comments.rst64
1 files changed, 0 insertions, 64 deletions
diff --git a/docs/source/lang/cpp/comments.rst b/docs/source/lang/cpp/comments.rst
deleted file mode 100644
index 1428dc3..0000000
--- a/docs/source/lang/cpp/comments.rst
+++ /dev/null
@@ -1,64 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-comments:
-
-Comments
-========
-
-Comments are lines in the program that are used to inform yourself or
-others about the way the program works. They are ignored by the
-compiler, and not exported to the processor, so they don't take up any
-space in RAM or Flash.
-
-One use for comments is to help you understand (or remember) how your
-program works, or to inform others how your program works. There are
-two different ways of making comments.
-
-.. _lang-comments-singleline:
-
-**Single line comment**: Anything following two slashes, ``//``, until
-the end of the line, is a comment::
-
- x = 5; // the rest of this line is a comment
-
-.. _lang-comments-multiline:
-
-**Multi-line comment**: Anything in between a pair of ``/*`` and ``*/``
-is a comment::
-
- /* <-- a slash-star begins a multi-line comment
-
- all of this in the multi-line comment - you can use it to comment
- out whole blocks of code
-
- if (gwb == 0){ // single line comment is OK inside a multi-line comment
- x = 3;
- }
-
- // don't forget the "closing" star-slash - they have to be balanced:
- */
-
-Note that it's okay to use single-line comments within a multi-line
-comment, but you can't use multi-line comments within a multi-line
-comment. Here's an example::
-
- /* ok, i started a multi-line comment
-
- x = 3; /* this next star-slash ENDS the multi-line comment: */
-
- x = 4; // this line is outside of the multi-line comment
-
- // next line is also outside of the comment, and causes a compile error:
- */
-
-Programming Tip
----------------
-
-When experimenting with code, "commenting out" parts of your program
-is a convenient way to remove lines that may be buggy. This leaves
-the lines in the code, but turns them into comments, so the compiler
-just ignores them. This can be especially useful when trying to locate
-a problem, or when a program refuses to compile and the compiler error
-is cryptic or unhelpful.
-
-.. include:: /arduino-cc-attribution.txt