mirror of https://github.com/MLXXXp/Arduboy2.git
Explicitly specify the type in doxygen code blocks
Just to be safe.
This commit is contained in:
parent
c00fee0a78
commit
d76eb15c51
|
@ -26,7 +26,7 @@
|
||||||
* A user program can test this value to conditionally compile based on the
|
* A user program can test this value to conditionally compile based on the
|
||||||
* library version. For example:
|
* library version. For example:
|
||||||
*
|
*
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* // If the library is version 2.1.0 or higher
|
* // If the library is version 2.1.0 or higher
|
||||||
* #if ARDUBOY_LIB_VER >= 20100
|
* #if ARDUBOY_LIB_VER >= 20100
|
||||||
* // ... code that make use of a new feature added to V2.1.0
|
* // ... code that make use of a new feature added to V2.1.0
|
||||||
|
@ -136,7 +136,7 @@ struct Point
|
||||||
*
|
*
|
||||||
* Example:
|
* Example:
|
||||||
*
|
*
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* #include <Arduboy2.h>
|
* #include <Arduboy2.h>
|
||||||
*
|
*
|
||||||
* Arduboy2 arduboy;
|
* Arduboy2 arduboy;
|
||||||
|
@ -316,7 +316,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
*
|
*
|
||||||
* The prototype for the function provided to draw the logo is:
|
* The prototype for the function provided to draw the logo is:
|
||||||
|
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* void drawLogo(int16_t y);
|
* void drawLogo(int16_t y);
|
||||||
* \endcode
|
* \endcode
|
||||||
*
|
*
|
||||||
|
@ -735,7 +735,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
* displaying the next frame.
|
* displaying the next frame.
|
||||||
*
|
*
|
||||||
* example:
|
* example:
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* void loop() {
|
* void loop() {
|
||||||
* if (!arduboy.nextFrame()) {
|
* if (!arduboy.nextFrame()) {
|
||||||
* return; // go back to the start of the loop
|
* return; // go back to the start of the loop
|
||||||
|
@ -790,7 +790,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
* For example, if you wanted to fire a shot every 5 frames while the A button
|
* For example, if you wanted to fire a shot every 5 frames while the A button
|
||||||
* is being held down:
|
* is being held down:
|
||||||
*
|
*
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* if (arduboy.everyXFrames(5)) {
|
* if (arduboy.everyXFrames(5)) {
|
||||||
* if arduboy.pressed(A_BUTTON) {
|
* if arduboy.pressed(A_BUTTON) {
|
||||||
* fireShot();
|
* fireShot();
|
||||||
|
@ -879,7 +879,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
* The `justPressed()` and `justReleased()` functions rely on this function.
|
* The `justPressed()` and `justReleased()` functions rely on this function.
|
||||||
*
|
*
|
||||||
* example:
|
* example:
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* void loop() {
|
* void loop() {
|
||||||
* if (!arduboy.nextFrame()) {
|
* if (!arduboy.nextFrame()) {
|
||||||
* return;
|
* return;
|
||||||
|
@ -1033,7 +1033,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
* Sketches can use the defined value `ARDUBOY_UNIT_NAME_LEN` instead of
|
* Sketches can use the defined value `ARDUBOY_UNIT_NAME_LEN` instead of
|
||||||
* hard coding a 6 when working with the unit name. For example, to allocate
|
* hard coding a 6 when working with the unit name. For example, to allocate
|
||||||
* a buffer and read the unit name into it:
|
* a buffer and read the unit name into it:
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* // Buffer for maximum name length plus the terminator
|
* // Buffer for maximum name length plus the terminator
|
||||||
* char unitName[ARDUBOY_UNIT_NAME_LEN + 1];
|
* char unitName[ARDUBOY_UNIT_NAME_LEN + 1];
|
||||||
*
|
*
|
||||||
|
@ -1117,7 +1117,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
* way that using `everyXFrames()` might.
|
* way that using `everyXFrames()` might.
|
||||||
*
|
*
|
||||||
* example:
|
* example:
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* // move for 10 frames when right button is pressed, if not already moving
|
* // move for 10 frames when right button is pressed, if not already moving
|
||||||
* if (!moving) {
|
* if (!moving) {
|
||||||
* if (arduboy.justPressed(RIGHT_BUTTON)) {
|
* if (arduboy.justPressed(RIGHT_BUTTON)) {
|
||||||
|
@ -1221,7 +1221,7 @@ class Arduboy2 : public Print, public Arduboy2Base
|
||||||
* https://www.arduino.cc/en/Serial/Print
|
* https://www.arduino.cc/en/Serial/Print
|
||||||
*
|
*
|
||||||
* Example:
|
* Example:
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* int value = 42;
|
* int value = 42;
|
||||||
*
|
*
|
||||||
* arduboy.println("Hello World"); // Prints "Hello World" and then moves the
|
* arduboy.println("Hello World"); // Prints "Hello World" and then moves the
|
||||||
|
|
|
@ -28,7 +28,7 @@
|
||||||
*
|
*
|
||||||
* Example:
|
* Example:
|
||||||
*
|
*
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* #include <Arduboy2.h>
|
* #include <Arduboy2.h>
|
||||||
*
|
*
|
||||||
* Arduboy2 arduboy;
|
* Arduboy2 arduboy;
|
||||||
|
@ -52,7 +52,7 @@
|
||||||
* `enabled()` type function to be passed as a parameter in the constructor,
|
* `enabled()` type function to be passed as a parameter in the constructor,
|
||||||
* like so:
|
* like so:
|
||||||
*
|
*
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* #include <Arduboy2.h>
|
* #include <Arduboy2.h>
|
||||||
* #include <ArduboyTones.h>
|
* #include <ArduboyTones.h>
|
||||||
*
|
*
|
||||||
|
|
|
@ -78,7 +78,7 @@
|
||||||
* The following is a basic example sketch, which will generate a tone when
|
* The following is a basic example sketch, which will generate a tone when
|
||||||
* a button is pressed.
|
* a button is pressed.
|
||||||
*
|
*
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* #include <Arduboy2.h>
|
* #include <Arduboy2.h>
|
||||||
* // There's no need to #include <Arduboy2Beep.h>
|
* // There's no need to #include <Arduboy2Beep.h>
|
||||||
* // It will be included in Arduboy2.h
|
* // It will be included in Arduboy2.h
|
||||||
|
@ -135,7 +135,7 @@ class BeepPin1
|
||||||
* tone).
|
* tone).
|
||||||
*
|
*
|
||||||
* Example:
|
* Example:
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* beep.tone(beep.freq(1000), 15);
|
* beep.tone(beep.freq(1000), 15);
|
||||||
* while (beep.duration != 0) { } // wait for the tone to stop playing
|
* while (beep.duration != 0) { } // wait for the tone to stop playing
|
||||||
* \endcode
|
* \endcode
|
||||||
|
@ -236,7 +236,7 @@ class BeepPin1
|
||||||
* if necessary.
|
* if necessary.
|
||||||
*
|
*
|
||||||
* Example:
|
* Example:
|
||||||
* \code
|
* \code{.cpp}
|
||||||
* beep.tone(beep.freq(440)); // play a 440Hz tone until stopped or replaced
|
* beep.tone(beep.freq(440)); // play a 440Hz tone until stopped or replaced
|
||||||
* \endcode
|
* \endcode
|
||||||
*
|
*
|
||||||
|
|
Loading…
Reference in New Issue