Merge pull request #559 from per1234/standard-syntax-parameters-returns-formatting

Use standard format for Syntax, Parameters, and Returns sections

Author: robsoncouto

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 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

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 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

Language/Functions/Advanced IO/shiftIn.adoc

@@ -32,16 +32,14 @@ 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

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

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 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

Language/Functions/Analog IO/analogRead.adoc

@@ -38,17 +38,17 @@ On ATmega based boards (UNO, Nano, Mini, Mega), it takes about 100 microseconds
 
 [float]
 === Syntax
-
 `analogRead(pin)`
 
+
 [float]
 === Parameters
 `pin`: the name of the analog input pin to read from (A0 to A5 on most boards, A0 to A6 on MKR boards, A0 to A7 on the Mini and Nano, A0 to A15 on the Mega).
 
+
 [float]
 === Returns
-
-The analog reading on the pin (int). Although it is limited to the resolution of the analog to digital converter (0-1023 for 10 bits or 0-4095 for 12 bits).
+The analog reading on the pin. Although it is limited to the resolution of the analog to digital converter (0-1023 for 10 bits or 0-4095 for 12 bits). Data type: `int`.
 
 --
 // OVERVIEW SECTION ENDS

Language/Functions/Analog IO/analogReference.adoc

@@ -52,6 +52,7 @@ Arduino SAM Boards (Due)
 === Parameters
 `type`: which type of reference to use (see list of options in the description).
 
+
 [float]
 === Returns
 Nothing

Language/Functions/Analog IO/analogWrite.adoc

@@ -33,8 +33,8 @@ The `analogWrite` function has nothing to do with the analog pins or the `analog
 
 [float]
 === Parameters
-`pin`: the pin to write to. Allowed data types: int. +
-`value`: the duty cycle: between 0 (always off) and 255 (always on). Allowed data types: int
+`pin`: the pin to write to. Allowed data types: `int`. +
+`value`: the duty cycle: between 0 (always off) and 255 (always on). Allowed data types: `int`.
 
 
 [float]

Language/Functions/Bits and Bytes/bit.adoc

@@ -30,6 +30,7 @@ Computes the value of the specified bit (bit 0 is 1, bit 1 is 2, bit 2 is 4, etc
 === Parameters
 `n`: the bit whose value to compute
 
+
 [float]
 === Returns
 The value of the bit.

Language/Functions/Bits and Bytes/bitClear.adoc

@@ -28,9 +28,9 @@ Clears (writes a 0 to) a bit of a numeric variable.
 
 [float]
 === Parameters
-`x`: the numeric variable whose bit to clear
+`x`: the numeric variable whose bit to clear. +
+`n`: which bit to clear, starting at 0 for the least-significant (rightmost) bit.
 
-`n`: which bit to clear, starting at 0 for the least-significant (rightmost) bit
 
 [float]
 === Returns