From 4abba955a7a53c2a74169a28f1683b8ca6cbaa2a Mon Sep 17 00:00:00 2001 From: Phillip Burgess Date: Fri, 1 Mar 2019 19:51:40 -0800 Subject: [PATCH] Doxygen cleanup --- Adafruit_SPITFT.cpp | 23 ++++++++++++----------- Adafruit_SPITFT.h | 18 ++++++++---------- 2 files changed, 20 insertions(+), 21 deletions(-) diff --git a/Adafruit_SPITFT.cpp b/Adafruit_SPITFT.cpp index 52a9791..a61f370 100644 --- a/Adafruit_SPITFT.cpp +++ b/Adafruit_SPITFT.cpp @@ -299,7 +299,7 @@ Adafruit_SPITFT::Adafruit_SPITFT(uint16_t w, uint16_t h, SPIClass *spiClass, tie CS low). @param rst Arduino pin # for display reset (optional, display reset can be tied to MCU reset, default of -1 means unused). - @param wr Arduino pin # for read strobe (optional, -1 if unused). + @param rd Arduino pin # for read strobe (optional, -1 if unused). @return Adafruit_SPITFT object. @note Output pins are not initialized; application typically will need to call subclass' begin() function, which in turn calls this @@ -1084,7 +1084,7 @@ void inline Adafruit_SPITFT::writeFastHLine(int16_t x, int16_t y, int16_t w, contained drawFastVLine() instead. @param x Horizontal position of first point. @param y Vertical position of first point. - @param w Line height in pixels (positive = below first point, + @param h Line height in pixels (positive = below first point, negative = above first point). @param color 16-bit line color in '565' RGB format. */ @@ -1365,13 +1365,14 @@ void Adafruit_SPITFT::invertDisplay(bool i) { } /*! - @brief Given 8-bit red, green and blue values, return a 'packed' - 16-bit color value in '565' RGB format (5 bits red, 6 bits - green, 5 bits blue). This is just a mathematical operation, - no hardware is touched. - @param red 8-bit red brightnesss (0 = off, 255 = max). - @param green 8-bit green brightnesss (0 = off, 255 = max). - @param blue 8-bit blue brightnesss (0 = off, 255 = max). + @brief Given 8-bit red, green and blue values, return a 'packed' + 16-bit color value in '565' RGB format (5 bits red, 6 bits + green, 5 bits blue). This is just a mathematical operation, + no hardware is touched. + @param red 8-bit red brightnesss (0 = off, 255 = max). + @param green 8-bit green brightnesss (0 = off, 255 = max). + @param blue 8-bit blue brightnesss (0 = off, 255 = max). + @return 'Packed' 16-bit color value (565 format). */ uint16_t Adafruit_SPITFT::color565(uint8_t red, uint8_t green, uint8_t blue) { return ((red & 0xF8) << 8) | ((green & 0xFC) << 3) | (blue >> 3); @@ -1475,7 +1476,7 @@ void Adafruit_SPITFT::spiWrite(uint8_t b) { the device to COMMAND mode, issues the byte and then restores DATA mode. There is no corresponding explicit writeData() function -- just use spiWrite(). - @param b 8-bit command to write. + @param cmd 8-bit command to write. */ void Adafruit_SPITFT::writeCommand(uint8_t cmd) { SPI_DC_LOW(); @@ -1713,7 +1714,7 @@ void Adafruit_SPITFT::SPI_WRITE16(uint16_t w) { parallel; name was maintaned for backward compatibility. Naming is also not consistent with the 8-bit version, spiWrite(). Sorry about that. Again, staying compatible with outside code. - @param w 16-bit value to write. + @param l 32-bit value to write. */ void Adafruit_SPITFT::SPI_WRITE32(uint32_t l) { switch(connection) { diff --git a/Adafruit_SPITFT.h b/Adafruit_SPITFT.h index 02639c6..12914d9 100644 --- a/Adafruit_SPITFT.h +++ b/Adafruit_SPITFT.h @@ -11,13 +11,9 @@ * please support Adafruit and open-source hardware by purchasing * products from Adafruit! * - * @section author Author - * * Written by Limor "ladyada" Fried for Adafruit Industries, * with contributions from the open source community. * - * @section license License - * * BSD license, all text here must be included in any redistribution. */ @@ -244,7 +240,6 @@ class Adafruit_SPITFT : public Adafruit_GFX { // compatibility (some subclasses may be invoking these): void SPI_WRITE16(uint16_t w); // Not inline void SPI_WRITE32(uint32_t l); // Not inline - void SPI_WRITE_PIXELS(uint16_t *data, uint32_t bytes); // ditto // Old code had both a spiWrite16() function and SPI_WRITE16 macro // in addition to the SPI_WRITE32 macro. The latter two have been // made into functions here, and spiWrite16() removed (use SPI_WRITE16() @@ -379,9 +374,12 @@ class Adafruit_SPITFT : public Adafruit_GFX { #endif struct { // Values specific to HARDWARE SPI: SPIClass *_spi; ///< SPI class pointer - uint32_t _freq; - SPISettings settings; - } hwspi; +#if defined(SPI_HAS_TRANSACTION) + SPISettings settings; ///< SPI transaction settings +#else + uint32_t _freq; ///< SPI bitrate (if no SPI transactions) +#endif + } hwspi; ///< Hardware SPI values struct { // Values specific to SOFTWARE SPI: #if defined(USE_FAST_PINIO) PORTreg_t misoPort; ///< PORT (PIN) register for MISO @@ -409,7 +407,7 @@ class Adafruit_SPITFT : public Adafruit_GFX { int8_t _mosi; ///< MOSI pin # int8_t _miso; ///< MISO pin # int8_t _sck; ///< SCK pin # - } swspi; + } swspi; ///< Software SPI values struct { // Values specific to 8-bit parallel: #if defined(USE_FAST_PINIO) volatile uint8_t *writePort; ///< PORT register for DATA WRITE @@ -443,7 +441,7 @@ class Adafruit_SPITFT : public Adafruit_GFX { int8_t _wr; ///< Write strobe pin # int8_t _rd; ///< Read strobe pin # (or -1) bool wide = 0; ///< If true, is 16-bit interface - } tft8; + } tft8; ///< Parallel interface settings #if !defined(ARDUINO_STM32_FEATHER) }; #endif