Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PXCT-583] Language Reference Broken Links Fix #999

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Language/Functions/Communication/Print.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Print class is related to several libraries in Arduino that use the printing fun

Some of the libraries that use the Print class are:

* link:../serial[Serial]
* link:https://www.arduino.cc/en/Reference/serial[Serial]
* link:https://reference.arduino.cc/reference/en/libraries/liquidcrystal/[LiquidCrystal]
* link:https://www.arduino.cc/en/Reference/Ethernet[Ethernet]
* link:https://reference.arduino.cc/reference/en/libraries/wifi/wificlient/[Wifi]
Expand All @@ -41,8 +41,8 @@ Some of the libraries that use the Print class are:
[float]
=== Functions
link:https://www.arduino.cc/reference/en/language/functions/communication/wire/write/[write()] +
link:https://www.arduino.cc/reference/en/language/functions/communication/serial/print/[print()] +
link:https://www.arduino.cc/reference/en/language/functions/communication/serial/println/[println()]
link:https://www.arduino.cc/en/Reference/serial/print/[print()] +
link:https://www.arduino.cc/en/Reference/serial/println/[println()]

'''

Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/available.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Get the number of bytes (characters) available for reading from the serial port.

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page].


[float]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Get the number of bytes (characters) available for writing in the serial buffer

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page].


[float]
Expand Down
4 changes: 2 additions & 2 deletions Language/Functions/Communication/Serial/begin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ An optional second argument configures the data, parity, and stop bits. The defa

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`speed`: in bits per second (baud). Allowed data types: `long`. +
`config`: sets data, parity, and stop bits. Valid values are: +
`SERIAL_5N1` +
Expand Down Expand Up @@ -112,7 +112,7 @@ Thanks to Jeff Gray for the mega example

[float]
=== Notes and Warnings
For USB CDC serial ports (e.g. `Serial` on the Leonardo), `Serial.begin()` is irrelevant. You can use any baud rate and configuration for serial communication with these ports. See the list of available serial ports for each board on the link:../../serial[Serial main page].
For USB CDC serial ports (e.g. `Serial` on the Leonardo), `Serial.begin()` is irrelevant. You can use any baud rate and configuration for serial communication with these ports. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page].

The only `config` value supported for `Serial1` on the Arduino Nano 33 BLE and Nano 33 BLE Sense boards is `SERIAL_8N1`.
[%hardbreaks]
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/end.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Disables serial communication, allowing the RX and TX pins to be used for genera

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page].


[float]
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/find.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ title: Serial.find()

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`target`: the string to search for. Allowed data types: `char`. +
`length`: length of the target. Allowed data types: `size_t`.

Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/findUntil.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The function returns true if the target string is found, false if it times out.

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`target`: the string to search for. Allowed data types: `char`. +
`terminal`: the terminal string in the search. Allowed data types: `char`.

Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/flush.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Waits for the transmission of outgoing serial data to complete.

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page].


[float]
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/parseFloat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ title: Serial.parseFloat()

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`lookahead`: the mode used to look ahead in the stream for a floating point number. Allowed data types: `LookaheadMode`. Allowed `lookahead` values:

* `SKIP_ALL`: all characters other than a minus sign, decimal point, or digits are ignored when scanning the stream for a floating point number. This is the default mode.
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/parseInt.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ In particular:

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`lookahead`: the mode used to look ahead in the stream for an integer. Allowed data types: `LookaheadMode`. Allowed `lookahead` values:

* `SKIP_ALL`: all characters other than digits or a minus sign are ignored when scanning the stream for an integer. This is the default mode.
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/peek.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Returns the next byte (character) of incoming serial data without removing it fr

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page].


[float]
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/print.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ To send data without conversion to its representation as characters, use link:..

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`val`: the value to print. Allowed data types: any data type.


Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/println.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Prints data to the serial port as human-readable ASCII text followed by a carria

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`val`: the value to print. Allowed data types: any data type. +
`format`: specifies the number base (for integral data types) or number of decimal places (for floating point types).

Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/read.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Reads incoming serial data.

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page].


[float]
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/readBytes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ title: Serial.readBytes()

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`buffer`: the buffer to store the bytes in. Allowed data types: array of `char` or `byte`. +
`length`: the number of bytes to read. Allowed data types: `int`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Serial.readBytesUntil() reads characters from the serial buffer into an array. T

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`character`: the character to search for. Allowed data types: `char`. +
`buffer`: the buffer to store the bytes in. Allowed data types: array of `char` or `byte`. +
`length`: the number of bytes to read. Allowed data types: `int`.
Expand Down
4 changes: 2 additions & 2 deletions Language/Functions/Communication/Serial/readString.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ title: Serial.readString()

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page].


[float]
Expand Down Expand Up @@ -85,7 +85,7 @@ The function does not terminate early if the data contains end of line character
=== See also

[role="language"]
* #LANGUAGE# link:../../serial[Serial]
* #LANGUAGE# link:https://www.arduino.cc/en/Reference/serial[Serial]
* #LANGUAGE# link:../begin[begin()]
* #LANGUAGE# link:../end[end()]
* #LANGUAGE# link:../available[available()]
Expand Down
4 changes: 2 additions & 2 deletions Language/Functions/Communication/Serial/readStringUntil.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ title: Serial.readStringUntil()

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`terminator`: the character to search for. Allowed data types: `char`.


Expand Down Expand Up @@ -62,7 +62,7 @@ If the terminator character can't be found, all read characters will be discarde
=== See also

[role="language"]
* #LANGUAGE# link:../../serial[Serial]
* #LANGUAGE# link:https://www.arduino.cc/en/Reference/serial[Serial]
* #LANGUAGE# link:../begin[begin()]
* #LANGUAGE# link:../end[end()]
* #LANGUAGE# link:../available[available()]
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/setTimeout.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ title: Serial.setTimeout()

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`time`: timeout duration in milliseconds. Allowed data types: `long`.


Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/write.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Writes binary data to the serial port. This data is sent as a byte or series of

[float]
=== Parameters
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
`_Serial_`: serial port object. See the list of available serial ports for each board on the link:https://www.arduino.cc/en/Reference/serial[Serial main page]. +
`val`: a value to send as a single byte. +
`str`: a string to send as a series of bytes. +
`buf`: an array to send as a series of bytes. +
Expand Down
4 changes: 2 additions & 2 deletions Language/Functions/Communication/stream.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Stream defines the reading functions in Arduino. When using any core functionali

Some of the libraries that rely on Stream include :

* link:../serial[Serial]
* link:https://www.arduino.cc/en/Reference/Wire[Wire]
* link:https://www.arduino.cc/en/Reference/serial[Serial]
* link:https://www.arduino.cc/en/Reference/wire[Wire]
* link:https://www.arduino.cc/en/Reference/Ethernet[Ethernet]
* link:https://www.arduino.cc/en/Reference/SD[SD]

Expand Down