From 457f65992cd0d382ec6e6a58a5c60bf7474cdf8d Mon Sep 17 00:00:00 2001 From: Robson Date: Mon, 18 Feb 2019 12:20:23 -0300 Subject: [PATCH] Fixes in the data type pages --- Language/Variables/Data Types/array.adoc | 5 ----- Language/Variables/Data Types/bool.adoc | 5 ----- Language/Variables/Data Types/boolean.adoc | 5 ----- Language/Variables/Data Types/byte.adoc | 7 +------ Language/Variables/Data Types/char.adoc | 7 +------ Language/Variables/Data Types/double.adoc | 7 +------ Language/Variables/Data Types/float.adoc | 8 +++++--- Language/Variables/Data Types/int.adoc | 6 ++++-- Language/Variables/Data Types/long.adoc | 7 +++++-- Language/Variables/Data Types/short.adoc | 9 ++++++--- Language/Variables/Data Types/size_t.adoc | 5 ----- Language/Variables/Data Types/string.adoc | 5 ----- Language/Variables/Data Types/stringObject.adoc | 7 +------ Language/Variables/Data Types/unsignedChar.adoc | 7 +------ Language/Variables/Data Types/unsignedInt.adoc | 11 ++++------- Language/Variables/Data Types/unsignedLong.adoc | 13 +++++-------- Language/Variables/Data Types/void.adoc | 7 +------ Language/Variables/Data Types/word.adoc | 5 ----- 18 files changed, 35 insertions(+), 91 deletions(-) diff --git a/Language/Variables/Data Types/array.adoc b/Language/Variables/Data Types/array.adoc index faa4d459f..b1115cab9 100644 --- a/Language/Variables/Data Types/array.adoc +++ b/Language/Variables/Data Types/array.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = Arrays - // OVERVIEW SECTION STARTS [#overview] -- diff --git a/Language/Variables/Data Types/bool.adoc b/Language/Variables/Data Types/bool.adoc index a765fffd0..0bd33c9df 100644 --- a/Language/Variables/Data Types/bool.adoc +++ b/Language/Variables/Data Types/bool.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = bool - // OVERVIEW SECTION STARTS [#overview] -- diff --git a/Language/Variables/Data Types/boolean.adoc b/Language/Variables/Data Types/boolean.adoc index 2335600c3..95c5fae9d 100644 --- a/Language/Variables/Data Types/boolean.adoc +++ b/Language/Variables/Data Types/boolean.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = boolean - // OVERVIEW SECTION STARTS [#overview] -- diff --git a/Language/Variables/Data Types/byte.adoc b/Language/Variables/Data Types/byte.adoc index 069647dfa..9e3c6e8ef 100644 --- a/Language/Variables/Data Types/byte.adoc +++ b/Language/Variables/Data Types/byte.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = byte - // OVERVIEW SECTION STARTS [#overview] -- @@ -55,4 +50,4 @@ A byte stores an 8-bit unsigned number, from 0 to 255. * #LANGUAGE# link:../../conversion/bytecast[byte()] -- -// SEE ALSO SECTION ENDS \ No newline at end of file +// SEE ALSO SECTION ENDS diff --git a/Language/Variables/Data Types/char.adoc b/Language/Variables/Data Types/char.adoc index 3aab9ba2d..8d1d7c2b3 100644 --- a/Language/Variables/Data Types/char.adoc +++ b/Language/Variables/Data Types/char.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = char - // OVERVIEW SECTION STARTS [#overview] -- @@ -71,4 +66,4 @@ The char datatype is a signed type, meaning that it encodes numbers from -128 to * #LANGUAGE# link:../../../functions/communication/serial/println[Serial.println] -- -// SEE ALSO SECTION ENDS \ No newline at end of file +// SEE ALSO SECTION ENDS diff --git a/Language/Variables/Data Types/double.adoc b/Language/Variables/Data Types/double.adoc index 3ffe960d4..8e29b325c 100644 --- a/Language/Variables/Data Types/double.adoc +++ b/Language/Variables/Data Types/double.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = double - // OVERVIEW SECTION STARTS [#overview] -- @@ -63,4 +58,4 @@ Users who borrow code from other sources that includes double variables may wish === See also -- -// SEE ALSO SECTION ENDS \ No newline at end of file +// SEE ALSO SECTION ENDS diff --git a/Language/Variables/Data Types/float.adoc b/Language/Variables/Data Types/float.adoc index bbb91a30f..33b3fede9 100644 --- a/Language/Variables/Data Types/float.adoc +++ b/Language/Variables/Data Types/float.adoc @@ -32,8 +32,10 @@ If doing math with floats, you need to add a decimal point, otherwise it will be === Syntax `float var=val;` -`var` - your float variable name -`val` - the value you assign to that variable +[float] +=== Parameters +`var`: variable name + +`val`: the value you assign to that variable [%hardbreaks] -- @@ -80,4 +82,4 @@ If doing math with floats, you need to add a decimal point, otherwise it will be [role="language"] -- -// SEE ALSO SECTION ENDS \ No newline at end of file +// SEE ALSO SECTION ENDS diff --git a/Language/Variables/Data Types/int.adoc b/Language/Variables/Data Types/int.adoc index e4539db7c..46be9831d 100644 --- a/Language/Variables/Data Types/int.adoc +++ b/Language/Variables/Data Types/int.adoc @@ -28,8 +28,10 @@ The Arduino takes care of dealing with negative numbers for you, so that arithme === Syntax `int var = val;` -`var` - your int variable name + -`val` - the value you assign to that variable +[float] +=== Parameters +`var`: variable name + +`val`: the value you assign to that variable -- // OVERVIEW SECTION ENDS diff --git a/Language/Variables/Data Types/long.adoc b/Language/Variables/Data Types/long.adoc index f85fb1592..fa6efb845 100644 --- a/Language/Variables/Data Types/long.adoc +++ b/Language/Variables/Data Types/long.adoc @@ -27,8 +27,11 @@ If doing math with integers, at least one of the numbers must be followed by an `long var = val;` -`var` - the long variable name -`val` - the value assigned to the variable +[float] +=== Parameters +`var`: variable name + +`val`: the value assigned to the variable + [%hardbreaks] -- // OVERVIEW SECTION ENDS diff --git a/Language/Variables/Data Types/short.adoc b/Language/Variables/Data Types/short.adoc index fb18aacc2..4f831124b 100644 --- a/Language/Variables/Data Types/short.adoc +++ b/Language/Variables/Data Types/short.adoc @@ -26,8 +26,11 @@ On all Arduinos (ATMega and ARM based) a short stores a 16-bit (2-byte) value. T === Syntax `short var = val;` -`var` - your short variable name -`val` - the value you assign to that variable +[float] +=== Parameters +`var`: variable name + +`val`: the value you assign to that variable + -- // OVERVIEW SECTION ENDS @@ -63,4 +66,4 @@ On all Arduinos (ATMega and ARM based) a short stores a 16-bit (2-byte) value. T * #LANGUAGE# link:../../constants/integerconstants[Integer Constants] -- -// SEE ALSO SECTION ENDS \ No newline at end of file +// SEE ALSO SECTION ENDS diff --git a/Language/Variables/Data Types/size_t.adoc b/Language/Variables/Data Types/size_t.adoc index 83d708c40..1dd1308fc 100644 --- a/Language/Variables/Data Types/size_t.adoc +++ b/Language/Variables/Data Types/size_t.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = size_t - // OVERVIEW SECTION STARTS [#overview] -- diff --git a/Language/Variables/Data Types/string.adoc b/Language/Variables/Data Types/string.adoc index b42dcb2f7..cc04cf426 100644 --- a/Language/Variables/Data Types/string.adoc +++ b/Language/Variables/Data Types/string.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = string - // OVERVIEW SECTION STARTS [#overview] -- diff --git a/Language/Variables/Data Types/stringObject.adoc b/Language/Variables/Data Types/stringObject.adoc index 2926197ee..3a870ba7a 100644 --- a/Language/Variables/Data Types/stringObject.adoc +++ b/Language/Variables/Data Types/stringObject.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = String() - // OVERVIEW SECTION STARTS [#overview] -- @@ -64,7 +59,7 @@ String(val, decimalPlaces) [float] === Parameters `val`: a variable to format as a String - *Allowed data types:* string, char, byte, int, long, unsigned int, unsigned long, float, double + -`base` (optional): the base in which to format an integral value +`base` (optional): the base in which to format an integral value + `decimalPlaces` (*only if val is float or double*): the desired decimal places [float] diff --git a/Language/Variables/Data Types/unsignedChar.adoc b/Language/Variables/Data Types/unsignedChar.adoc index cad9a538b..229f34337 100644 --- a/Language/Variables/Data Types/unsignedChar.adoc +++ b/Language/Variables/Data Types/unsignedChar.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = unsigned char - // OVERVIEW SECTION STARTS [#overview] -- @@ -70,4 +65,4 @@ unsigned char myChar = 240; * #LANGUAGE# link:../../../functions/communication/serial/println[Serial.println] -- -// SEE ALSO SECTION ENDS \ No newline at end of file +// SEE ALSO SECTION ENDS diff --git a/Language/Variables/Data Types/unsignedInt.adoc b/Language/Variables/Data Types/unsignedInt.adoc index 4949a0b58..28ce80dd8 100644 --- a/Language/Variables/Data Types/unsignedInt.adoc +++ b/Language/Variables/Data Types/unsignedInt.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = unsigned int - // OVERVIEW SECTION STARTS [#overview] -- @@ -30,9 +25,11 @@ The difference between unsigned ints and (signed) ints, lies in the way the high [float] === Syntax `unsigned int var = val;` -`var` - your unsigned int variable name -`val` - the value you assign to that variable +[float] +=== Parameters +`var`: variable name + +`val`: the value you assign to that variable // HOW TO USE SECTION STARTS [#howtouse] diff --git a/Language/Variables/Data Types/unsignedLong.adoc b/Language/Variables/Data Types/unsignedLong.adoc index 9cccdf9e1..93b8a658f 100644 --- a/Language/Variables/Data Types/unsignedLong.adoc +++ b/Language/Variables/Data Types/unsignedLong.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = unsigned long - // OVERVIEW SECTION STARTS [#overview] -- @@ -25,8 +20,10 @@ Unsigned long variables are extended size variables for number storage, and stor `unsigned long var = val;` -`var` - your long variable name -`val` - the value you assign to that variable +[float] +=== Parameters +`var`: variable name + +`val`: the value you assign to that variable [%hardbreaks] -- @@ -79,4 +76,4 @@ void loop() * #LANGUAGE# link:../../constants/integerconstants[Integer Constants] -- -// SEE ALSO SECTION ENDS \ No newline at end of file +// SEE ALSO SECTION ENDS diff --git a/Language/Variables/Data Types/void.adoc b/Language/Variables/Data Types/void.adoc index 6ab03f354..9d5dbc8b2 100644 --- a/Language/Variables/Data Types/void.adoc +++ b/Language/Variables/Data Types/void.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = void - // OVERVIEW SECTION STARTS [#overview] -- @@ -67,4 +62,4 @@ void loop() * #LANGUAGE# link:../../constants/integerconstants[Integer Constants] -- -// SEE ALSO SECTION ENDS \ No newline at end of file +// SEE ALSO SECTION ENDS diff --git a/Language/Variables/Data Types/word.adoc b/Language/Variables/Data Types/word.adoc index 4c32fcff5..60846882c 100644 --- a/Language/Variables/Data Types/word.adoc +++ b/Language/Variables/Data Types/word.adoc @@ -4,13 +4,8 @@ categories: [ "Variables" ] subCategories: [ "Data Types" ] --- - - - - = word - // OVERVIEW SECTION STARTS [#overview] --