diff options
| author | Marti Bolivar <mbolivar@mit.edu> | 2010-11-28 11:23:33 -0500 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@mit.edu> | 2010-11-28 11:23:33 -0500 |
| commit | d9cbd78e29d42e70bb46641dd43ee0772c8c975f (patch) | |
| tree | 80a67cba4468dbcd89b3cd23ad56695b1f146c66 /source/arduino/highbyte.rst | |
| parent | 546b34076d230b617ba86defb6b90cd934b01878 (diff) | |
| download | librambutan-d9cbd78e29d42e70bb46641dd43ee0772c8c975f.tar.gz librambutan-d9cbd78e29d42e70bb46641dd43ee0772c8c975f.zip | |
reorganized all the arduino/ docs into a lang/ subdirectory since
they're properly CC attributed now.
Diffstat (limited to 'source/arduino/highbyte.rst')
| -rw-r--r-- | source/arduino/highbyte.rst | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/source/arduino/highbyte.rst b/source/arduino/highbyte.rst deleted file mode 100644 index 5b1c24e..0000000 --- a/source/arduino/highbyte.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _arduino-highbyte: - -highByte(x) -=========== - -.. warning:: This macro is provided for compatibility with Arduino - only. It returns the second-least significant byte in an integral - value. It makes sense to call this the "high" byte on a 16-bit - ``int`` microcontroller like the Atmel chips on Arduinos, but it - makes no sense at all on a 32-bit microcontroller like the STM32s - in the Maple line. - - In short: we provide this so that existing Arduino code works as - expected, but **strongly discourage its use** in new programs. - -Description ------------ - -(Macro) Extracts the second lowest byte of an integral data type. - -Parameters ----------- - -**x**: a value of any integral type. - -Returns -------- - -Second lowest byte in **x**. - -Example -------- - -:: - - int x = 0xDEADBEEF; - SerialUSB.println(x, HEX); // prints "BE" - -Arduino Compatibility ---------------------- - -The Maple version of ``highByte()`` is compatible with Arduino. - -See Also --------- - -- :ref:`lowByte() <arduino-lowbyte>` - - - - - -.. include:: cc-attribution.txt |