diff --git a/library.properties b/library.properties index ac21dc7..05e30ed 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Arduboy2 version=3.0.0 author=Chris J. Martinez, Kevin Bates, Josh Goebel, Scott Allen, Ross O. Shoger -maintainer=Scott Allen saydisp-git@yahoo.ca +maintainer=Scott Allen 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. category=Other diff --git a/src/Arduboy2.h b/src/Arduboy2.h index 845c862..12d68de 100644 --- a/src/Arduboy2.h +++ b/src/Arduboy2.h @@ -116,6 +116,7 @@ struct Point * The main functions provided for writing sketches for the Arduboy, * _minus_ text output. * + * \details * This class in inherited by Arduboy2, so if text output functions are * required Arduboy2 should be used instead. * @@ -556,6 +557,7 @@ class Arduboy2Base : public Arduboy2Core * * \param rate The desired frame rate in frames per second. * + * \details * 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 * be 60. @@ -602,6 +604,7 @@ class Arduboy2Base : public Arduboy2Core * * \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 * event. It will return `true` if the given number of frames has elapsed * 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. * + * \details * 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. * @@ -794,6 +798,7 @@ class Arduboy2Base : public Arduboy2Core * * \return `true1 if the first rectangle is intersecting the second. * + * \details * This function is intended to detemine if an object, whose boundaries are * are defined by the given rectangle, is in contact with another rectangular * object. @@ -805,6 +810,7 @@ class Arduboy2Base : public Arduboy2Core /** \brief * The display buffer array in RAM. * + * \details * The display buffer (also known as the screen buffer) contains an * image bitmap of the desired contents of the display, which is written * to the display using the `display()` function. The drawing functions of diff --git a/src/Arduboy2Core.h b/src/Arduboy2Core.h index 03d4062..d179358 100644 --- a/src/Arduboy2Core.h +++ b/src/Arduboy2Core.h @@ -336,6 +336,7 @@ class Arduboy2Core * \param inverse `true` will invert the display. `false` will set the * display to no-inverted. * + * \details * 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 * will be off. @@ -408,6 +409,7 @@ class Arduboy2Core * * \param command The command byte to send to the display. * + * \details * 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. * Multi-byte commands can be sent by calling this function multiple times.