Merge branch 'master' into patch-4

Author: robsoncouto

.drone.yml

@@ -7,4 +7,4 @@ pipeline:
       - bcmi-labs/reference
     when:
       branch: [master]
-      event: push
+      event: push

AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc

@@ -3,7 +3,7 @@
 
 // This is a documentation file for authors and editors of the Arduino Manutius content platform.
 // Below you can find a list of all the possible page elements with the corresponding
-// AsciiDoc syntax 
+// AsciiDoc syntax
 
 
 // GENERAL GUIDELINES
@@ -99,14 +99,14 @@ mailto:[email protected][This is an e-mail link]
 This is `code` in a sentence +
 `This is a whole line of code` +
 
-// HINT: Please note that sometimes when copy-pasting code a few spaces can be added at the beginnng of each line of code. 
+// HINT: Please note that sometimes when copy-pasting code a few spaces can be added at the beginnng of each line of code.
 // If that happens, please remove the extra spaces. Thanks!
 
-This can be a lot more code 
+This can be a lot more code
 [source,arduino]
 ----
-for (int 1; i<=99; i++) {
-	Serial.println('We want more code!');
+for (int i = 0; i <= 99; i++) {
+  Serial.println('We want more code!');
 }
 ----
 [%hardbreaks]
@@ -115,7 +115,7 @@ for (int 1; i<=99; i++) {
 
 // TABLES
 |===
-|Name of Column 1 |Name of Column 2 |Name of Column 3 
+|Name of Column 1 |Name of Column 2 |Name of Column 3
 
 |Cell in column 1, row 1
 |Cell in column 2, row 1
@@ -135,7 +135,7 @@ for (int 1; i<=99; i++) {
 
 // IMAGES
 
-// If you need to add an image to the Asciidoc please create a folder called 'attachments' in the same directory as the Asciidoc file, 
+// If you need to add an image to the Asciidoc please create a folder called 'attachments' in the same directory as the Asciidoc file,
 // place the image there and reference it as shown below. Images can be in SVG and PNG format, max size 200KB.
 
 // To include an image on its own line (i.e., a block image), use the image:: prefix in front of the file name and square brackets after it []

AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc

@@ -1,6 +1,6 @@
 ---
 title: Parent of Entity Title
-categories: [ "Functions" ] 
+categories: [ "Functions" ]
 subCategories: [ "Subcategory Name" ]
 ---
 // ARDUINO LANGUAGE REFERENCE TAG (above)   ►►►►► ALWAYS INCLUDE IN YOUR FILE ◄◄◄◄◄
@@ -78,7 +78,7 @@ http://arduino.cc[serialEvent()]
 
 [float]
 === See also
-// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#), 
+// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#),
 // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials
 // (please add the tag #EXAMPLE#)  ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄
 
@@ -87,6 +87,7 @@ http://arduino.cc[serialEvent()]
 // Whenever you want to link to another Reference term, or more in general to a relative link,
 // use the syntax shown below. Please note that the file format is subsituted by  attribute.
 // Please note that you always need to replace spaces that you might find in folder/file names with %20
+// The entire link to Reference pages must be lower case, regardless of the case of the folders and files in this repository.
 * #LANGUAGE# link:../AsciiDoc_Template-Single_Entity[Single Entity]
 * #LANGUAGE# link:../../AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary[AsciiDoc Template Dictionary]
 

AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc

@@ -76,13 +76,11 @@ int ledPin = 9;      // LED connected to digital pin 9
 int analogPin = 3;   // potentiometer connected to analog pin 3
 int val = 0;         // variable to store the read value
 
-void setup()
-{
+void setup() {
   pinMode(ledPin, OUTPUT);   // sets the pin as output
 }
 
-void loop()
-{
+void loop() {
   val = analogRead(analogPin);   // read the input pin
   analogWrite(ledPin, val / 4);  // analogRead values go from 0 to 1023, analogWrite values from 0 to 255
 }
@@ -108,7 +106,7 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption="
 
 [float]
 === See also
-// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#), 
+// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#),
 // definitions: (please add the tag #DEFINITION#), and examples of Projects and Tutorials
 // examples: (please add the tag #EXAMPLE#)
 
@@ -117,7 +115,8 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption="
 // Whenever you want to link to another Reference term, or more in general to a relative link,
 // use the syntax shown below. Please note that the file format is subsituted by  attribute.
 // Please note that you always need to replace spaces that you might find in folder/file names with %20
-// for language tag, items will be automatically generated for any other item of the same subcategory, 
+// The entire link to Reference pages must be lower case, regardless of the case of the folders and files in this repository.
+// For language tag, items will be automatically generated for any other item of the same subcategory,
 // no need to add links to other pages of the same subcategory
 // if you don't include this section, a minimal version with only the other pages of the same subcategory will be generated.
 * #LANGUAGE# link:../AsciiDoc_Template-Parent_Of_Entities[Parent Of Entities]
@@ -133,4 +132,3 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption="
 
 --
 // SEE ALSO SECTION ENDS
-

Language/Functions/Advanced IO/noTone.adoc

@@ -27,7 +27,7 @@ Stops the generation of a square wave triggered by `tone()`. Has no effect if no
 
 [float]
 === Parameters
-`pin`: the pin on which to stop generating the tone
+`pin`: the Arduino pin on which to stop generating the tone
 
 [float]
 === Returns
@@ -50,3 +50,14 @@ If you want to play different pitches on multiple pins, you need to call noTone(
 
 --
 // HOW TO USE SECTION ENDS
+
+
+// SEE ALSO SECTION
+[#see_also]
+--
+
+[float]
+=== See also
+
+--
+// SEE ALSO SECTION ENDS

Language/Functions/Advanced IO/pulseIn.adoc

@@ -25,20 +25,20 @@ The timing of this function has been determined empirically and will probably sh
 
 [float]
 === Syntax
-`pulseIn(pin, value)`
-
+`pulseIn(pin, value)` +
 `pulseIn(pin, value, timeout)`
 
+
 [float]
 === Parameters
-`pin`: the number of the pin on which you want to read the pulse. (int)
+`pin`: the number of the Arduino pin on which you want to read the pulse. Allowed data types: `int`. +
+`value`: type of pulse to read: either link:../../../variables/constants/constants/[HIGH] or link:../../../variables/constants/constants/[LOW]. Allowed data types: `int`. +
+`timeout` (optional): the number of microseconds to wait for the pulse to start; default is one second. Allowed data types: `unsigned long`.
 
-`value`: type of pulse to read: either link:../../../variables/constants/constants/[HIGH] or link:../../../variables/constants/constants/[LOW]. (int)
 
-`timeout` (optional): the number of microseconds to wait for the pulse to start; default is one second (unsigned long)
 [float]
 === Returns
-the length of the pulse (in microseconds) or 0 if no pulse started before the timeout (unsigned long)
+The length of the pulse (in microseconds) or 0 if no pulse started before the timeout. Data type: `unsigned long`.
 
 --
 // OVERVIEW SECTION ENDS
@@ -53,24 +53,35 @@ the length of the pulse (in microseconds) or 0 if no pulse started before the ti
 [float]
 === Example Code
 // Describe what the example code is all about and add relevant code   ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄
-The example calculated the time duration of a pulse on pin 7.
+The example prints the time duration of a pulse on pin 7.
 
 [source,arduino]
 ----
 int pin = 7;
 unsigned long duration;
 
-void setup()
-{
+void setup() {
+  Serial.begin(9600);
   pinMode(pin, INPUT);
 }
 
-void loop()
-{
+void loop() {
   duration = pulseIn(pin, HIGH);
+  Serial.println(duration);
 }
 ----
 [%hardbreaks]
 
 --
 // HOW TO USE SECTION ENDS
+
+
+// SEE ALSO SECTION
+[#see_also]
+--
+
+[float]
+=== See also
+
+--
+// SEE ALSO SECTION ENDS

Language/Functions/Advanced IO/pulseInLong.adoc

@@ -27,20 +27,20 @@ The timing of this function has been determined empirically and will probably sh
 
 [float]
 === Syntax
-`pulseInLong(pin, value)`
-
+`pulseInLong(pin, value)` +
 `pulseInLong(pin, value, timeout)`
 
+
 [float]
 === Parameters
-`pin`: the number of the pin on which you want to read the pulse. (int)
+`pin`: the number of the Arduino pin on which you want to read the pulse. Allowed data types: `int`. +
+`value`: type of pulse to read: either link:../../../variables/constants/constants/[HIGH] or link:../../../variables/constants/constants/[LOW]. Allowed data types: `int`. +
+`timeout` (optional): the number of microseconds to wait for the pulse to start; default is one second. Allowed data types: `unsigned long`.
 
-`value`: type of pulse to read: either link:../../../variables/constants/constants/[HIGH] or link:../../../variables/constants/constants/[LOW]. (int)
 
-`timeout` (optional): the number of microseconds to wait for the pulse to start; default is one second (unsigned long)
 [float]
 === Returns
-the length of the pulse (in microseconds) or 0 if no pulse started before the timeout (unsigned long)
+The length of the pulse (in microseconds) or 0 if no pulse started before the timeout. Data type: `unsigned long`.
 
 --
 // OVERVIEW SECTION ENDS
@@ -55,19 +55,21 @@ the length of the pulse (in microseconds) or 0 if no pulse started before the ti
 [float]
 === Example Code
 // Describe what the example code is all about and add relevant code   ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄
-The example calculated the time duration of a pulse on pin 7.
+The example prints the time duration of a pulse on pin 7.
 
 [source,arduino]
 ----
 int pin = 7;
 unsigned long duration;
 
 void setup() {
+  Serial.begin(9600);
   pinMode(pin, INPUT);
 }
 
 void loop() {
   duration = pulseInLong(pin, HIGH);
+  Serial.println(duration);
 }
 ----
 [%hardbreaks]
@@ -78,3 +80,14 @@ This function relies on micros() so cannot be used in link:../../interrupts/noin
 
 --
 // HOW TO USE SECTION ENDS
+
+
+// SEE ALSO SECTION
+[#see_also]
+--
+
+[float]
+=== See also
+
+--
+// SEE ALSO SECTION ENDS

Language/Functions/Advanced IO/shiftIn.adoc

@@ -32,16 +32,25 @@ Note: this is a software implementation; Arduino also provides an link:https://w
 
 [float]
 === Parameters
-`dataPin`: the pin on which to input each bit (int)
+`dataPin`: the pin on which to input each bit. Allowed data types: `int`. +
+`clockPin`: the pin to toggle to signal a read from *dataPin*. +
+`bitOrder`: which order to shift in the bits; either *MSBFIRST* or *LSBFIRST*. (Most Significant Bit First, or, Least Significant Bit First).
 
-`clockPin`: the pin to toggle to signal a read from *dataPin*
-
-`bitOrder`: which order to shift in the bits; either *MSBFIRST* or *LSBFIRST*.
-(Most Significant Bit First, or, Least Significant Bit First)
 
 [float]
 === Returns
-the value read (byte)
+The value read. Data type: `byte`.
+
+--
+// OVERVIEW SECTION ENDS
+
+
+// SEE ALSO SECTION
+[#see_also]
+--
+
+[float]
+=== See also
 
 --
-// OVERVIEW SECTION ENDS
+// SEE ALSO SECTION ENDS

Language/Functions/Advanced IO/shiftOut.adoc

@@ -28,14 +28,11 @@ This is a software implementation; see also the https://www.arduino.cc/en/Refere
 
 [float]
 === Parameters
-`dataPin`: the pin on which to output each bit (int)
+`dataPin`: the pin on which to output each bit. Allowed data types: `int`. +
+`clockPin`: the pin to toggle once the dataPin has been set to the correct value. Allowed data types: `int`. +
+`bitOrder`: which order to shift out the bits; either MSBFIRST or LSBFIRST. (Most Significant Bit First, or, Least Significant Bit First). +
+`value`: the data to shift out. Allowed data types: `byte`.
 
-`clockPin`: the pin to toggle once the dataPin has been set to the correct value (int)
-
-`bitOrder`: which order to shift out the bits; either MSBFIRST or LSBFIRST.
-(Most Significant Bit First, or, Least Significant Bit First)
-
-`value`: the data to shift out. (byte)
 
 [float]
 === Returns
@@ -121,3 +118,14 @@ shiftOut(dataPin, clock, LSBFIRST, (data >> 8));
 
 --
 // HOW TO USE SECTION ENDS
+
+
+// SEE ALSO SECTION
+[#see_also]
+--
+
+[float]
+=== See also
+
+--
+// SEE ALSO SECTION ENDS

Language/Functions/Advanced IO/tone.adoc

@@ -29,19 +29,16 @@ It is not possible to generate tones lower than 31Hz. For technical details, see
 
 [float]
 === Syntax
-`tone(pin, frequency)`
-
+`tone(pin, frequency)` +
 `tone(pin, frequency, duration)`
-[%hardbreaks]
+
 
 [float]
 === Parameters
-`pin`: the pin on which to generate the tone
+`pin`: the Arduino pin on which to generate the tone. +
+`frequency`: the frequency of the tone in hertz. Allowed data types: `unsigned int`. +
+`duration`: the duration of the tone in milliseconds (optional). Allowed data types: `unsigned long`.
 
-`frequency`: the frequency of the tone in hertz - `unsigned int`
-
-`duration`: the duration of the tone in milliseconds (optional) - `unsigned long`
-[%hardbreaks]
 
 [float]
 === Returns
@@ -77,11 +74,12 @@ If you want to play different pitches on multiple pins, you need to call `noTone
 * #LANGUAGE# link:../../analog-io/analogwrite[analogWrite()]
 
 [role="example"]
-* #EXAMPLE# http://arduino.cc/en/Tutorial/Tone[Tone^]
-* #EXAMPLE# http://arduino.cc/en/Tutorial/Tone[Pitch follower^]
-* #EXAMPLE# http://arduino.cc/en/Tutorial/Tone3[Simple Keyboard^]
-* #EXAMPLE# http://arduino.cc/en/Tutorial/Tone4[multiple tones^]
+
+* #EXAMPLE# http://arduino.cc/en/Tutorial/Tone[Tone Melody^]
+* #EXAMPLE# http://arduino.cc/en/Tutorial/tonePitchFollower[Pitch Follower^]
+* #EXAMPLE# http://arduino.cc/en/Tutorial/Tone3[Tone Keyboard^]
+* #EXAMPLE# http://arduino.cc/en/Tutorial/Tone4[Tone Multiple^]
 * #EXAMPLE# http://arduino.cc/en/Tutorial/PWM[PWM^]
 
 --
-// SEE ALSO SECTION ENDS
+// SEE ALSO SECTION ENDS