diff options
author | Marti Bolivar <mbolivar@mit.edu> | 2010-12-03 20:18:00 -0500 |
---|---|---|
committer | Marti Bolivar <mbolivar@mit.edu> | 2010-12-03 20:18:00 -0500 |
commit | 210f3d2b1555bae87c9de27ea145e16d3bddb0f8 (patch) | |
tree | 5e409fff948c9a1847d08e5ec34f905ea2212956 /source/lang/return.rst | |
parent | 11573d0fca18ef2ccd965ab67d419afd48b7cef2 (diff) | |
download | librambutan-210f3d2b1555bae87c9de27ea145e16d3bddb0f8.tar.gz librambutan-210f3d2b1555bae87c9de27ea145e16d3bddb0f8.zip |
cleaning up previous commits.
note that addition of new files under docs/source/lang/api and
docs/source/lang/cpp which were just copies of files in
docs/source/lang/ imply that change history is lost to git.
Diffstat (limited to 'source/lang/return.rst')
-rw-r--r-- | source/lang/return.rst | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/source/lang/return.rst b/source/lang/return.rst deleted file mode 100644 index 7b5039e..0000000 --- a/source/lang/return.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. highlight:: cpp - -.. _lang-return: - -``return`` -========== - -Terminates a function and return a value from a function to the -calling function, if the function has non-``void`` return type. - -Syntax: -------- - -:: - - // from within a "void" function: - return; - - // from within a non-"void" function: - return value; - -In the second case, ``value`` should have a type which is the same as -the return type of the function, or be convertible to it (like an -``int`` to a ``long``, etc.; see :ref:`this note -<lang-arithmetic-typeconversion>` for some references). - -Examples: ---------- - -A function to compare a sensor input to a threshold:: - - // converts analog readings between 0 and 400 to 0, and 400 up to 1. - int checkSensor() { - if (analogRead(0) > 400) { - return 1; - else { - return 0; - } - } - -An early ``return`` is also useful when testing a section of code -without having to "comment out" large sections of possibly buggy code, -like so:: - - void loop() { - - // brilliant code idea to test here - - return; - - // the rest of a dysfunctional sketch here - // this code will never be executed - } - -See Also --------- - -- :ref:`comments <lang-comments>` - - -.. include:: cc-attribution.txt |