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

139
Adafruit_SPITFT.cpp
View File

@ -62,21 +62,21 @@ static void dma_callback(Adafruit_ZeroDMA *dma) {
// CONSTRUCTORS ------------------------------------------------------------ // CONSTRUCTORS ------------------------------------------------------------
/*! /*!
@brief Adafruit_SPITFT constructor for software (bitbang) SPI. @brief Adafruit_SPITFT constructor for software (bitbang) SPI.
@param w Display width in pixels at default rotation setting (0). @param w Display width in pixels at default rotation setting (0).
@param h Display height in pixels at default rotation setting (0). @param h Display height in pixels at default rotation setting (0).
@param cs Arduino pin # for chip-select (-1 if unused, tie CS low). @param cs Arduino pin # for chip-select (-1 if unused, tie CS low).
@param dc Arduino pin # for data/command select (required). @param dc Arduino pin # for data/command select (required).
@param mosi Arduino pin # for bitbang SPI MOSI signal (required). @param mosi Arduino pin # for bitbang SPI MOSI signal (required).
@param sck Arduino pin # for bitbang SPI SCK signal (required). @param sck Arduino pin # for bitbang SPI SCK signal (required).
@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).
@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) :
@ -170,18 +170,18 @@ Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h,
} }
/*! /*!
@brief Adafruit_SPITFT constructor for hardware SPI using the board's @brief Adafruit_SPITFT constructor for hardware SPI using the board's
default SPI peripheral. default SPI peripheral.
@param w Display width in pixels at default rotation setting (0). @param w Display width in pixels at default rotation setting (0).
@param h Display height in pixels at default rotation setting (0). @param h Display height in pixels at default rotation setting (0).
@param cs Arduino pin # for chip-select (-1 if unused, tie CS low). @param cs Arduino pin # for chip-select (-1 if unused, tie CS low).
@param dc Arduino pin # for data/command select (required). @param dc Arduino pin # for data/command select (required).
@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) {
@ -190,19 +190,19 @@ Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, int8_t cs,
} }
/*! /*!
@brief Adafruit_SPITFT constructor for hardware SPI using a specific @brief Adafruit_SPITFT constructor for hardware SPI using a specific
SPI peripheral. SPI peripheral.
@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 spiClass Pointer to SPIClass type (e.g. &SPI or &SPI1). @param spiClass Pointer to SPIClass type (e.g. &SPI or &SPI1).
@param cs Arduino pin # for chip-select (-1 if unused, tie CS low). @param cs Arduino pin # for chip-select (-1 if unused, tie CS low).
@param dc Arduino pin # for data/command select (required). @param dc Arduino pin # for data/command select (required).
@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),
@ -261,36 +261,35 @@ 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 stick a required boolean argument in there to
stick a required boolean argument in there to disambiguate this constructor from the soft-SPI case.
disambiguate this constructor from the soft-SPI case. Argument is ignored on 8-bit architectures (no 'wide'
Argument is ignored on 8-bit architectures (no 'wide' support there since PORTs are 8 bits anyway).
support there since PORTs are 8 bits anyway). @param d0 Arduino pin # for data bit 0 (1+ are extrapolated).
@param d0 Arduino pin # for data bit 0 (1+ are extrapolated). The 8 (or 16) data bits MUST be contiguous and byte-
The 8 (or 16) data bits MUST be contiguous and byte- aligned (or word-aligned for wide interface) within the
aligned (or word-aligned for wide interface) within the same PORT register (might not correspond to Arduino pin
same PORT register (might not correspond to Arduino pin sequence).
sequence). @param wr Arduino pin # for write strobe (required).
@param wr Arduino pin # for write strobe (required). @param dc Arduino pin # for data/command select (required).
@param dc Arduino pin # for data/command select (required). @param cs Arduino pin # for chip-select (optional, -1 if unused,
@param cs Arduino pin # for chip-select (optional, -1 if unused, tie CS low).
tie CS low). @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). @param wr Arduino pin # for read strobe (optional, -1 if unused).
@param wr Arduino pin # for read strobe (optional, -1 if 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 need to call subclass' begin() function, which in turn calls this
to call subclass' begin() function, which in turn calls this library's initSPI() function to initialize pins.
library's initSPI() function to initialize pins. Yes, the name is a misnomer...this library originally handled
Yes, the name is a misnomer...this library originally handled only SPI displays, parallel being a recent addition (but not
only SPI displays, parallel being a recent addition (but not wanting to break existing code).
wanting to break existing code).
*/ */
Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, bool wide, Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, bool wide,
int8_t d0, int8_t wr, int8_t dc, int8_t cs, int8_t rst, int8_t rd) : int8_t d0, int8_t wr, int8_t dc, int8_t cs, int8_t rst, int8_t rd) :