mirror of https://github.com/MLXXXp/Arduboy2.git
Add missing "details" keyword to Doxygen comments
Also add missing angle brackets around email address in library.properties
This commit is contained in:
parent
4607f087a2
commit
3e82f484a2
|
@ -1,7 +1,7 @@
|
||||||
name=Arduboy2
|
name=Arduboy2
|
||||||
version=3.0.0
|
version=3.0.0
|
||||||
author=Chris J. Martinez, Kevin Bates, Josh Goebel, Scott Allen, Ross O. Shoger
|
author=Chris J. Martinez, Kevin Bates, Josh Goebel, Scott Allen, Ross O. Shoger
|
||||||
maintainer=Scott Allen saydisp-git@yahoo.ca
|
maintainer=Scott Allen <saydisp-git@yahoo.ca>
|
||||||
sentence=An alternative library for use with the Arduboy game system.
|
sentence=An alternative library for use with the Arduboy game system.
|
||||||
paragraph=This is a fork of the Arduboy library, with a main goal of providing ways in which more code space can be freed for use by large sketches. It remains substantially compatible with Arduboy library V1.1, with the main API difference being that the "tones" subclass has been removed and its functionality made available in a separate ArduboyPlaytune library. Removal of "tones" also allows other audio functions and libraries to be used, such as ArduboyTones.
|
paragraph=This is a fork of the Arduboy library, with a main goal of providing ways in which more code space can be freed for use by large sketches. It remains substantially compatible with Arduboy library V1.1, with the main API difference being that the "tones" subclass has been removed and its functionality made available in a separate ArduboyPlaytune library. Removal of "tones" also allows other audio functions and libraries to be used, such as ArduboyTones.
|
||||||
category=Other
|
category=Other
|
||||||
|
|
|
@ -116,6 +116,7 @@ struct Point
|
||||||
* The main functions provided for writing sketches for the Arduboy,
|
* The main functions provided for writing sketches for the Arduboy,
|
||||||
* _minus_ text output.
|
* _minus_ text output.
|
||||||
*
|
*
|
||||||
|
* \details
|
||||||
* This class in inherited by Arduboy2, so if text output functions are
|
* This class in inherited by Arduboy2, so if text output functions are
|
||||||
* required Arduboy2 should be used instead.
|
* required Arduboy2 should be used instead.
|
||||||
*
|
*
|
||||||
|
@ -556,6 +557,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
*
|
*
|
||||||
* \param rate The desired frame rate in frames per second.
|
* \param rate The desired frame rate in frames per second.
|
||||||
*
|
*
|
||||||
|
* \details
|
||||||
* Set the frame rate, in frames per second, used by `nextFrame()` to update
|
* Set the frame rate, in frames per second, used by `nextFrame()` to update
|
||||||
* frames at a given rate. If this function isn't used, the default rate will
|
* frames at a given rate. If this function isn't used, the default rate will
|
||||||
* be 60.
|
* be 60.
|
||||||
|
@ -602,6 +604,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
*
|
*
|
||||||
* \return `true` if the specified number of frames has elapsed.
|
* \return `true` if the specified number of frames has elapsed.
|
||||||
*
|
*
|
||||||
|
* \details
|
||||||
* This function should be called with the same value each time for a given
|
* This function should be called with the same value each time for a given
|
||||||
* event. It will return `true` if the given number of frames has elapsed
|
* event. It will return `true` if the given number of frames has elapsed
|
||||||
* since the previous frame in which it returned `true`.
|
* since the previous frame in which it returned `true`.
|
||||||
|
@ -779,6 +782,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
*
|
*
|
||||||
* \return `true` if the specified point is within the specified rectangle.
|
* \return `true` if the specified point is within the specified rectangle.
|
||||||
*
|
*
|
||||||
|
* \details
|
||||||
* This function is intended to detemine if an object, whose boundaries are
|
* This function is intended to detemine if an object, whose boundaries are
|
||||||
* are defined by the given rectangle, is in contact with the given point.
|
* are defined by the given rectangle, is in contact with the given point.
|
||||||
*
|
*
|
||||||
|
@ -794,6 +798,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
*
|
*
|
||||||
* \return `true1 if the first rectangle is intersecting the second.
|
* \return `true1 if the first rectangle is intersecting the second.
|
||||||
*
|
*
|
||||||
|
* \details
|
||||||
* This function is intended to detemine if an object, whose boundaries are
|
* This function is intended to detemine if an object, whose boundaries are
|
||||||
* are defined by the given rectangle, is in contact with another rectangular
|
* are defined by the given rectangle, is in contact with another rectangular
|
||||||
* object.
|
* object.
|
||||||
|
@ -805,6 +810,7 @@ class Arduboy2Base : public Arduboy2Core
|
||||||
/** \brief
|
/** \brief
|
||||||
* The display buffer array in RAM.
|
* The display buffer array in RAM.
|
||||||
*
|
*
|
||||||
|
* \details
|
||||||
* The display buffer (also known as the screen buffer) contains an
|
* The display buffer (also known as the screen buffer) contains an
|
||||||
* image bitmap of the desired contents of the display, which is written
|
* image bitmap of the desired contents of the display, which is written
|
||||||
* to the display using the `display()` function. The drawing functions of
|
* to the display using the `display()` function. The drawing functions of
|
||||||
|
|
|
@ -336,6 +336,7 @@ class Arduboy2Core
|
||||||
* \param inverse `true` will invert the display. `false` will set the
|
* \param inverse `true` will invert the display. `false` will set the
|
||||||
* display to no-inverted.
|
* display to no-inverted.
|
||||||
*
|
*
|
||||||
|
* \details
|
||||||
* Calling this function with a value of `true` will set the display to
|
* Calling this function with a value of `true` will set the display to
|
||||||
* inverted mode. A pixel with a value of 0 will be on and a pixel set to 1
|
* inverted mode. A pixel with a value of 0 will be on and a pixel set to 1
|
||||||
* will be off.
|
* will be off.
|
||||||
|
@ -408,6 +409,7 @@ class Arduboy2Core
|
||||||
*
|
*
|
||||||
* \param command The command byte to send to the display.
|
* \param command The command byte to send to the display.
|
||||||
*
|
*
|
||||||
|
* \details
|
||||||
* The display will be set to command mode then the specified command
|
* The display will be set to command mode then the specified command
|
||||||
* byte will be sent. The display will then be set to data mode.
|
* byte will be sent. The display will then be set to data mode.
|
||||||
* Multi-byte commands can be sent by calling this function multiple times.
|
* Multi-byte commands can be sent by calling this function multiple times.
|
||||||
|
|
Loading…
Reference in New Issue