aligned to last en

Author: smellai

Language/Functions/Advanced IO/shiftOut.adoc

@@ -17,7 +17,7 @@ Shifts out a byte of data one bit at a time. Starts from either the most (i.e. t
 
 Note- if you're interfacing with a device that's clocked by rising edges, you'll need to make sure that the clock pin is low before the call to `shiftOut()`, e.g. with a call to `digitalWrite(clockPin, LOW)`.
 
-This is a software implementation; see also the linkhttps://www.arduino.cc/en/Reference/SPI[SPI library], which provides a hardware implementation that is faster but works only on specific pins.
+This is a software implementation; see also the https://www.arduino.cc/en/Reference/SPI[SPI library], which provides a hardware implementation that is faster but works only on specific pins.
 [%hardbreaks]
 
 
@@ -54,7 +54,7 @@ Nothing
 [float]
 === Example Code
 // Describe what the example code is all about and add relevant code   ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄
-For accompanying circuit, see the http://arduino.cc/en/Tutorial/ShiftOut[tutorial on controlling a 74HC595 shift register].
+For accompanying circuit, see the https://arduino.cc/en/Tutorial/ShiftOut[tutorial on controlling a 74HC595 shift register].
 
 [source,arduino]
 ----

Language/Functions/Analog IO/analogRead.adoc

@@ -16,7 +16,7 @@ subCategories: [ "Analog I/O" ]
 
 [float]
 === Description
-Reads the value from the specified analog pin. The Arduino board contains a 6 channel (8 channels on the Mini and Nano, 16 on the Mega), 10-bit analog to digital converter. This means that it will map input voltages between 0 and 5 volts into integer values between 0 and 1023. This yields a resolution between readings of: 5 volts / 1024 units or, .0049 volts (4.9 mV) per unit. The input range and resolution can be changed using link:../analogreference[analogReference()]`.
+Reads the value from the specified analog pin. The Arduino board contains a 6 channel (8 channels on the Mini and Nano, 16 on the Mega), 10-bit analog to digital converter. This means that it will map input voltages between 0 and 5 volts into integer values between 0 and 1023. This yields a resolution between readings of: 5 volts / 1024 units or, .0049 volts (4.9 mV) per unit. The input range and resolution can be changed using link:../analogreference[analogReference()].
 
 It takes about 100 microseconds (0.0001 s) to read an analog input, so the maximum reading rate is about 10,000 times a second.
 [%hardbreaks]

Language/Functions/Analog IO/analogReference.adoc

@@ -19,11 +19,27 @@ subCategories: [ "Analog I/O" ]
 === Description
 Configures the reference voltage used for analog input (i.e. the value used as the top of the input range). The options are:
 
+Arduino AVR Boards (Uno, Mega, etc.)
+
 * DEFAULT: the default analog reference of 5 volts (on 5V Arduino boards) or 3.3 volts (on 3.3V Arduino boards)
 * INTERNAL: an built-in reference, equal to 1.1 volts on the ATmega168 or ATmega328P and 2.56 volts on the ATmega8 (not available on the Arduino Mega)
 * INTERNAL1V1: a built-in 1.1V reference (Arduino Mega only)
 * INTERNAL2V56: a built-in 2.56V reference (Arduino Mega only)
 * EXTERNAL: the voltage applied to the AREF pin (0 to 5V only) is used as the reference.
+
+Arduino SAMD Boards (Zero, etc.)
+
+* AR_DEFAULT: the default analog reference of 3.3V
+* AR_INTERNAL: a built-in 2.23V reference
+* AR_INTERNAL1V0: a built-in 1.0V reference
+* AR_INTERNAL1V65: a built-in 1.65V reference
+* AR_INTERNAL2V23: a built-in 2.23V reference
+* AR_EXTERNAL: the voltage applied to the AREF pin is used as the reference
+
+Arduino SAM Boards (Due)
+
+* AR_DEFAULT: the default analog reference of 3.3V. This is the only supported option for the Due.
+
 [%hardbreaks]
 
 
@@ -34,7 +50,7 @@ Configures the reference voltage used for analog input (i.e. the value used as t
 
 [float]
 === Parameters
-`type`: which type of reference to use (DEFAULT, INTERNAL, INTERNAL1V1, INTERNAL2V56, or EXTERNAL).
+`type`: which type of reference to use (see list of options in the description).
 
 [float]
 === Returns

Language/Functions/Characters/isHexadecimalDigit.adoc

@@ -1,4 +1,4 @@
----
+---
 title: "isHexadecimalDigit()"
 categories: [ "Functions" ]
 subCategories: [ "Characters" ]
@@ -25,7 +25,7 @@ Analyse if a char is an hexadecimal digit (A-F, 0-9). Returns true if thisChar c
 === Syntax
 [source,arduino]
 ----
-`isHexadecilamDigit(thisChar)`
+`isHexadecimalDigit(thisChar)`
 ----
 
 [float]
@@ -79,4 +79,4 @@ else
 * #LANGUAGE# link:../../communication/serial/read[read()]
 
 --
-// SEE ALSO SECTION ENDS
+// SEE ALSO SECTION ENDS

Language/Functions/Communication/Serial/available.adoc

@@ -2,9 +2,6 @@
 title: Serial.available()
 ---
 
-
-
-
 = available()
 
 
@@ -31,20 +28,21 @@ _Arduino Mega only:_
 
 [float]
 === Parameters
-Nothing
+None
 
 [float]
 === Returns
 The number of bytes available to read .
 --
 // OVERVIEW SECTION ENDS
 
-
-
-
 // HOW TO USE SECTION STARTS
 [#howtouse]
 --
+[float]
+=== Example Code
+// Describe what the example code is all about and add relevant code   ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄
+The following code returns a character received through the serial port. 
 
 [source,arduino]
 ----
@@ -56,7 +54,7 @@ void setup() {
 
 void loop() {
 
-	// send data only when you receive data:
+	// reply only when you receive data:
 	if (Serial.available() > 0) {
 		// read the incoming byte:
 		incomingByte = Serial.read();
@@ -70,6 +68,8 @@ void loop() {
 [%hardbreaks]
 
 *Arduino Mega example:*
+This code sends data received in one serial port of the Arduino Mega to another. This can be used, for example, to connect a serial device to the computer through the Arduino board.
+
 [source,arduino]
 ----
 void setup() {

Language/Functions/Communication/Serial/println.adoc

@@ -14,7 +14,7 @@ title: Serial.println()
 
 [float]
 === Description
-Prints data to the serial port as human-readable ASCII text followed by a carriage return character (ASCII 13, or '\r') and a newline character (ASCII 10, or '\n'). This command takes the same forms as link:../print[Serial.print().
+Prints data to the serial port as human-readable ASCII text followed by a carriage return character (ASCII 13, or '\r') and a newline character (ASCII 10, or '\n'). This command takes the same forms as link:../print[Serial.print()].
 [%hardbreaks]
 
 

Language/Functions/Communication/Serial/readBytesUntil.adoc

@@ -14,7 +14,7 @@ title: Serial.readBytesUntil()
 
 [float]
 === Description
-Serial.readBytesUntil() reads characters from the serial buffer into an array. The function terminates if the terminator character is detected, the determined length has been read, or it times out (see link:../settimeout[Serial.setTimeout()]).
+Serial.readBytesUntil() reads characters from the serial buffer into an array. The function terminates if the terminator character is detected, the determined length has been read, or it times out (see link:../settimeout[Serial.setTimeout()]). The function returns the characters up to the last character before the supplied terminator. The terminator itself is not returned in the buffer.
 
 `Serial.readBytesUntil()` returns the number of characters read into the buffer. A 0 means no valid data was found.
 

Language/Functions/Communication/Stream/streamReadBytes.adoc

@@ -14,7 +14,7 @@ title: Stream.readBytes()
 
 [float]
 === Description
-`readBytes()` read characters from a stream into a buffer. The function terminates if the determined length has been read, or it times out (see link:../streamSetTimeout[setTimeout()]).
+`readBytes()` read characters from a stream into a buffer. The function terminates if the determined length has been read, or it times out (see link:../streamsettimeout[setTimeout()]).
 
 `readBytes()` returns the number of bytes placed in the buffer. A 0 means no valid data was found.
 
@@ -40,4 +40,4 @@ This function is part of the Stream class, and is called by any class that inher
 The number of bytes placed in the buffer (`size_t`)
 
 --
-// OVERVIEW SECTION ENDS
+// OVERVIEW SECTION ENDS

Language/Functions/Communication/serial.adoc

@@ -73,7 +73,7 @@ link:../serial/serialevent[serialEvent()]
 === See also
 
 [role="example"]
-* #EXAMPLE# https://www.arduino.cc/en/Tutorial/ReadAsciiString[ReadAsciiString^]
+* #EXAMPLE# https://www.arduino.cc/en/Tutorial/ReadASCIIString[ReadASCIIString^]
 * #EXAMPLE# https://www.arduino.cc/en/Tutorial/ASCIITable[ASCII TAble^]
 * #EXAMPLE# https://www.arduino.cc/en/Tutorial/Dimmer[Dimmer^]
 * #EXAMPLE# https://www.arduino.cc/en/Tutorial/Graph[Graph^]

Language/Functions/Random Numbers/random.adoc

@@ -86,5 +86,7 @@ If it is important for a sequence of values generated by `random()` to differ, o
 
 Conversely, it can occasionally be useful to use pseudo-random sequences that repeat exactly. This can be accomplished by calling `randomSeed()` with a fixed number, before starting the random sequence.
 
+The `max` parameter should be chosen according to the data type of the variable in which the value is stored. In any case, the absolute maximum is bound to the `long` nature of the value generated (32 bit - 2,147,483,647). Setting `max` to a higher value won't generate an error during compilation, but during sketch execution the numbers generated will not be as expected.
+
 --
 // HOW TO USE SECTION ENDS

Language/Functions/Random Numbers/randomSeed.adoc

@@ -30,7 +30,7 @@ Conversely, it can occasionally be useful to use pseudo-random sequences that re
 
 [float]
 === Parameters
-`long`, `int` - pass a number to generate the seed.
+`seed` - number to initialize the pseudo-random sequence (unsigned long).
 
 [float]
 === Returns

Language/Structure/Bitwise Operators/bitwiseXor.adoc

@@ -49,7 +49,7 @@ int z = x ^ y;  // binary: 0110, or decimal 6
 ----
 [%hardbreaks]
 
-The ^ operator is often used to toggle (i.e. change from 0 to 1, or 1 to 0) some of the bits in an integer expression. In a bitwise OR operation if there is a 1 in the mask bit, that bit is inverted; if there is a 0, the bit is not inverted and stays the same. Below is a program to blink digital pin 5.
+The ^ operator is often used to toggle (i.e. change from 0 to 1, or 1 to 0) some of the bits in an integer expression. In a bitwise XOR operation if there is a 1 in the mask bit, that bit is inverted; if there is a 0, the bit is not inverted and stays the same. Below is a program to blink digital pin 5.
 
 [source,arduino]
 ----
@@ -82,4 +82,4 @@ delay(100);
 * #EXAMPLE# https://www.arduino.cc/playground/Code/BitMath[BitMath Tutorial^]
 
 --
-// SEE ALSO SECTION ENDS
+// SEE ALSO SECTION ENDS

Language/Structure/Control Structure/doWhile.adoc

@@ -1,5 +1,5 @@
 ---
-title: do...While
+title: do...while
 categories: [ "Structure" ]
 subCategories: [ "Control Structure" ]
 ---

Language/Structure/Control Structure/switchCase.adoc

@@ -1,5 +1,5 @@
 ---
-title: switchCase
+title: switch...case
 categories: [ "Structure" ]
 subCategories: [ "Control Structure" ]
 ---

Language/Structure/Pointer Access Operators/reference.adoc

@@ -1,6 +1,6 @@
 ---
 title: "&"
-title_expanded: reference opearator
+title_expanded: reference operator
 categories: [ "Structure" ]
 subCategories: [ "Pointer Access Operators" ]
 ---

Language/Structure/Sketch/loop.adoc

@@ -37,7 +37,7 @@ int buttonPin = 3;
 // setup initializes serial and the button pin
 void setup()
 {
-  beginSerial(9600);
+  Serial.begin(9600);
   pinMode(buttonPin, INPUT);
 }
 
@@ -46,9 +46,9 @@ void setup()
 void loop()
 {
   if (digitalRead(buttonPin) == HIGH)
-    serialWrite('H');
+    Serial.write('H');
   else
-    serialWrite('L');
+    Serial.write('L');
 
   delay(1000);
 }

Language/Variables/Data Types/String/Operators/comparison.adoc

@@ -1,14 +1,10 @@
----
+---
 title: "=="
 title_expanded: comparison
 categories: [ "Data Types" ]
 subCategories: [ "StringObject Operator" ]
 ---
 
-
-
-
-
 = == Comparison
 
 
@@ -37,7 +33,6 @@ string1 == string2
 
 [float]
 === Returns
-The nth char of the string. Same as charAt().
 `true`: if string1 equals string2
 
 `false`: otherwise
@@ -60,4 +55,4 @@ The nth char of the string. Same as charAt().
 [role="example"]
 * #EXAMPLE# link: https://www.arduino.cc/en/Tutorial/BuiltInExamples#strings[Built-in String Tutorials]
 --
-// SEE ALSO SECTION ENDS
+// SEE ALSO SECTION ENDS

Language/Variables/Data Types/String/Operators/greaterThanOrEqualTo.adoc

@@ -1,24 +1,19 @@
----
+---
 title: ">="
 title_expanded: greater than or equal to
 categories: [ "Data Types" ]
 subCategories: [ "StringObject Operator" ]
 ---
 
-
-
-
-
 = >= Greater Than Or Equal To
 
-
 // OVERVIEW SECTION STARTS
 [#overview]
 --
 
 [float]
 === Description
-Tests if the string on the left is greater than the string on the right. This operator evaluate strings in alphabetical order, on the first character where the two differ. So, for example "b" >= "a" and "2" >= "1", but "999" >= "1000" because 9 comes after 1.
+Tests if the string on the left is greater than, or equal to, the string on the right. This operator evaluate strings in alphabetical order, on the first character where the two differ. So, for example "b" >= "a" and "2" >= "1", but "999" >= "1000" because 9 comes after 1.
 
 Caution: String comparison operators can be confusing when you're comparing numeric strings, because the numbers are treated as strings and not as numbers. If you need to compare numbers numerically, compare them as ints, floats, or longs, and not as Strings.
 
@@ -61,4 +56,4 @@ string1 >= string2
 [role="example"]
 * #EXAMPLE# link: https://www.arduino.cc/en/Tutorial/BuiltInExamples#strings[Built-in String Tutorials]
 --
-// SEE ALSO SECTION ENDS
+// SEE ALSO SECTION ENDS

Language/Variables/Data Types/String/Operators/lessThan.adoc

@@ -1,17 +1,12 @@
----
+---
 title: "<"
 title_expanded: less thans
 categories: [ "Data Types" ]
 subCategories: [ "StringObject Operator" ]
 ---
 
-
-
-
-
 = < Less Than
 
-
 // OVERVIEW SECTION STARTS
 [#overview]
 --
@@ -38,7 +33,7 @@ string1 < string2
 
 [float]
 === Returns
-`true`: if string1 is greater than string2
+`true`: if string1 is less than string2
 
 `false`: otherwise
 --
@@ -60,4 +55,4 @@ string1 < string2
 [role="example"]
 * #EXAMPLE# link: https://www.arduino.cc/en/Tutorial/BuiltInExamples#strings[Built-in String Tutorials]
 --
-// SEE ALSO SECTION ENDS
+// SEE ALSO SECTION ENDS

Language/Variables/Data Types/array.adoc

@@ -18,6 +18,7 @@ subCategories: [ "Data Types" ]
 [float]
 === Description
 An array is a collection of variables that are accessed with an index number. Arrays in the C programming language, on which Arduino is based, can be complicated, but using simple arrays is relatively straightforward.
+[float]
 === Creating (Declaring) an Array
 
 All of the methods below are valid ways to create (declare) an array.
@@ -106,4 +107,4 @@ For a complete program that demonstrates the use of arrays, see the (http://www.
 
 
 --
-// SEE ALSO SECTION ENDS
+// SEE ALSO SECTION ENDS