alex/Adafruit-GFX-Library
1
0
Fork 0
mirror of https://github.com/adafruit/Adafruit-GFX-Library.git synced 2024-10-03 18:18:46 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Doxygen tidying

Browse Source
This commit is contained in:
Phillip Burgess 2019-02-28 17:27:58 -08:00
parent a295138e10
commit cb8c433a61
1 changed files with 69 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Adafruit_SPITFT.cpp
View File

@ -74,9 +74,9 @@ static void dma_callback(Adafruit_ZeroDMA *dma) {
@param miso Arduino pin # for bitbang SPI MISO signal (optional, @param miso Arduino pin # for bitbang SPI MISO signal (optional,
-1 default, many displays don't support SPI read). -1 default, many displays don't support SPI read).
@return Adafruit_SPITFT object. @return Adafruit_SPITFT object.
@note Output pins are not initialized; application typically will need @note Output pins are not initialized; application typically will
to call subclass' begin() function, which in turn calls this need to call subclass' begin() function, which in turn calls
library's initSPI() function to initialize pins. this library's initSPI() function to initialize pins.
*/ */
Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h,
int8_t cs, int8_t dc, int8_t mosi, int8_t sck, int8_t rst, int8_t miso) : int8_t cs, int8_t dc, int8_t mosi, int8_t sck, int8_t rst, int8_t miso) :
@ -179,9 +179,9 @@ Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h,
@param rst Arduino pin # for display reset (optional, display reset @param rst Arduino pin # for display reset (optional, display reset
can be tied to MCU reset, default of -1 means unused). can be tied to MCU reset, default of -1 means unused).
@return Adafruit_SPITFT object. @return Adafruit_SPITFT object.
@note Output pins are not initialized; application typically will need @note Output pins are not initialized; application typically will
to call subclass' begin() function, which in turn calls this need to call subclass' begin() function, which in turn calls
library's initSPI() function to initialize pins. this library's initSPI() function to initialize pins.
*/ */
Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, int8_t cs, Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, int8_t cs,
int8_t dc, int8_t rst) : Adafruit_SPITFT(w, h, &SPI, cs, dc, rst) { int8_t dc, int8_t rst) : Adafruit_SPITFT(w, h, &SPI, cs, dc, rst) {
@ -200,9 +200,9 @@ Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, int8_t cs,
@param rst Arduino pin # for display reset (optional, display reset @param rst Arduino pin # for display reset (optional, display reset
can be tied to MCU reset, default of -1 means unused). can be tied to MCU reset, default of -1 means unused).
@return Adafruit_SPITFT object. @return Adafruit_SPITFT object.
@note Output pins are not initialized; application typically will need @note Output pins are not initialized; application typically will
to call subclass' begin() function, which in turn calls this need to call subclass' begin() function, which in turn calls
library's initSPI() function to initialize pins. this library's initSPI() function to initialize pins.
*/ */
Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, SPIClass *spiClass, Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, SPIClass *spiClass,
int8_t cs, int8_t dc, int8_t rst) : Adafruit_GFX(w, h), int8_t cs, int8_t dc, int8_t rst) : Adafruit_GFX(w, h),
@ -264,7 +264,6 @@ Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, SPIClass *spiClass,
@brief Adafruit_SPITFT constructor for parallel display connection. @brief Adafruit_SPITFT constructor for parallel display connection.
@param w Display width in pixels at default rotation (0). @param w Display width in pixels at default rotation (0).
@param h Display height in pixels at default rotation (0). @param h Display height in pixels at default rotation (0).
@param wide If true, is a 16-bit parallel connection, else 8-bit. @param wide If true, is a 16-bit parallel connection, else 8-bit.
16-bit isn't fully implemented or tested yet so 16-bit isn't fully implemented or tested yet so
applications should pass "false" for now...needed to applications should pass "false" for now...needed to