Updated documentation

Descriptions of functions are updated.

Author: gogi640

src/Inkplate.cpp

@@ -65,6 +65,11 @@ void Inkplate::clearDisplay()
 
 /**
  * @brief       display function update display with new data from buffer
+ *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
  */
 void Inkplate::display(bool leaveOn)
 {

src/boards/Inkplate10.cpp

@@ -27,6 +27,11 @@
  * @brief       begin function initialize Inkplate object with predefined
  * settings
  *
+ * @param       uint8_t lightWaveform
+ *              if inkplate doesn't work well or if it is fading after turning off
+ *              lightWaveform should be set to 1 in order to fix that, but older boards
+ *              may not support it
+ *
  * @return      True if initialization is successful, false if failed or already
  * initialized
  */
@@ -198,6 +203,11 @@ void Graphics::writePixel(int16_t x0, int16_t y0, uint16_t color)
 /**
  *
  * @brief       display1b function writes black and white data to display
+ *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
  */
 void Inkplate::display1b(bool leaveOn)
 {
@@ -278,6 +288,11 @@ void Inkplate::display1b(bool leaveOn)
 
 /**
  * @brief       display3b function writes grayscale data to display
+ *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
  */
 void IRAM_ATTR Inkplate::display3b(bool leaveOn)
 {
@@ -355,6 +370,11 @@ void IRAM_ATTR Inkplate::display3b(bool leaveOn)
  *              For advanced use with deep sleep. Can force partial update in
  * deep sleep
  *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
+ *
  * @note        Partial update only works in black and white mode
  *
  * @return      Number of pixels changed from black to white, leaving blur

src/boards/Inkplate5.cpp

@@ -192,6 +192,12 @@ void Graphics::writePixel(int16_t x0, int16_t y0, uint16_t color)
 /**
  *
  * @brief       display1b function writes black and white data to display
+ *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
+ *              
  */
 void Inkplate::display1b(bool leaveOn)
 {
@@ -281,6 +287,11 @@ void Inkplate::display1b(bool leaveOn)
 
 /**
  * @brief       display3b function writes grayscale data to display
+ *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
  */
 void IRAM_ATTR Inkplate::display3b(bool leaveOn)
 {
@@ -340,6 +351,11 @@ void IRAM_ATTR Inkplate::display3b(bool leaveOn)
  *              For advanced use with deep sleep. Can force partial update in
  * deep sleep
  *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
+ *
  * @note        Partial update only works in black and white mode
  *
  * @return      Number of pixels changed from black to white, leaving blur

src/boards/Inkplate6.cpp

@@ -176,6 +176,11 @@ void Graphics::writePixel(int16_t x0, int16_t y0, uint16_t color)
 /**
  *
  * @brief       display1b function writes black and white data to display
+ *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
  */
 void Inkplate::display1b(bool leaveOn)
 {
@@ -296,6 +301,11 @@ void Inkplate::display1b(bool leaveOn)
 
 /**
  * @brief       display3b function writes grayscale data to display
+ *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
  */
 void Inkplate::display3b(bool leaveOn)
 {
@@ -357,6 +367,11 @@ void Inkplate::display3b(bool leaveOn)
  *              For advanced use with deep sleep. Can force partial update in
  * deep sleep
  *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
+ *
  * @note        Partial update only works in black and white mode
  *
  * @return      Number of pixels changed from black to white, leaving blur

src/boards/Inkplate6plus.cpp

@@ -260,6 +260,11 @@ void Inkplate::clean(uint8_t c, uint8_t rep)
 /**
  *
  * @brief       display1b function writes black and white data to display
+ *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
  */
 void Inkplate::display1b(bool leaveOn)
 {
@@ -350,6 +355,11 @@ void Inkplate::display1b(bool leaveOn)
 
 /**
  * @brief       display3b function writes grayscale data to display
+ *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
  */
 void Inkplate::display3b(bool leaveOn)
 {
@@ -410,6 +420,11 @@ void Inkplate::display3b(bool leaveOn)
  *              For advanced use with deep sleep. Can force partial update in
  * deep sleep
  *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
+ *
  * @note        Partial update only works in black and white mode
  *
  * @return      Number of pixels changed from black to white, leaving blur

src/boards/InkplateColor.cpp

@@ -116,6 +116,11 @@ bool Inkplate::begin(void)
 
 /**
  * @brief       display function update display with new data from buffer
+ *
+ * @param       bool leaveOn
+ *              if set to 1, it will disable turning supply for eink after
+ *              display update in order to save some time needed for power supply
+ *              to save some time at next display update or increase refreshing speed
  */
 void Inkplate::display(bool leaveOn)
 {

src/include/Graphics.cpp

@@ -75,6 +75,9 @@ uint8_t Graphics::getRotation()
  *              x position, will change depending on rotation
  * @param       int16_t y0
  *              y position, will change depending on rotation
+ *
+ * @param       uint16_t color
+ *              pixel color, in 3bit mode have values in range 0-7
  */
 void Graphics::drawPixel(int16_t x0, int16_t y0, uint16_t color)
 {
@@ -97,8 +100,8 @@ void Graphics::startWrite()
  *              rectangle width
  * @param       int16_t h
  *              rectangle height
- * @param       int16_t c
- *              rectangle grayscale color (1-7)
+ * @param       uint16_t color
+ *              pixel color, in 3bit mode have values in range 0-7
  */
 void Graphics::writeFillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color)
 {
@@ -117,8 +120,8 @@ void Graphics::writeFillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_
  *              starting y position for vertical line
  * @param       int16_t h
  *              vertical line height
- * @param       int16_t c
- *              vertical line grayscale color (1-7)
+ * @param       uint16_t color
+ *              pixel color, in 3bit mode have values in range 0-7
  */
 void Graphics::writeFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color)
 {
@@ -136,8 +139,8 @@ void Graphics::writeFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color)
  *              starting y position for horizontal line
  * @param       int16_t w
  *              horizontal line width
- * @param       int16_t c
- *              horizontal line grayscale color (1-7)
+ * @param       uint16_t color
+ *              pixel color, in 3bit mode have values in range 0-7
  */
 void Graphics::writeFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color)
 {
@@ -156,8 +159,8 @@ void Graphics::writeFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color)
  *              ending x position for line
  * @param       int16_t y1
  *              ending y position for line
- * @param       int16_t c
- *              line grayscale color (1-7)
+ * @param       uint16_t color
+ *              pixel color, in 3bit mode have values in range 0-7
  */
 void Graphics::writeLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color)
 {

src/include/ImageDitherColor.cpp

@@ -109,6 +109,17 @@ uint8_t Image::ditherGetPixelBmp(uint32_t px, int i, int j, int w, bool paletted
 /**
  * @brief       ditherGetPixelJpeg finds dithered value for given pixel
  *
+ * @param       uint32_t px
+ *              pixel to find value for
+ * @param       int i
+ *              x plane pixel position
+ * @param       int j
+ *              y plane pixel position
+ * @param       int w
+ *              image width
+ * @param       bool paletted
+ *              1 if palleted image, 0 if not
+ *
  * @note        currently not used
  */
 uint8_t Image::ditherGetPixelJpeg(uint8_t px, int i, int j, int x, int y, int w, int h)

src/include/System.cpp

@@ -630,6 +630,20 @@ uint8_t System::rtcGetAlarmWeekday()
 
 /**
  * @brief                   Sets the timer countdown
+ *
+ * @param                   rtcCountdownSrcClock source_clock
+ *                          timer clock frequency
+ *
+ * @param                   timer clock frequency
+ *                          value to write in timer register
+ *
+ * @param                   bool int_enable
+ *                          timer interrupt enable, 0 means no interrupt generated from timer
+ *                          , 1 means interrupt is generated from timer
+ *
+ * @param                   bool int_pulse
+ *                          timer interrupt mode, 0 means interrupt follows timer flag
+ *                          , 1 means interrupt generates a pulse
  */
 void System::rtcTimerSet(rtcCountdownSrcClock source_clock, uint8_t value, bool int_enable, bool int_pulse)
 {
@@ -650,7 +664,7 @@ void System::rtcTimerSet(rtcCountdownSrcClock source_clock, uint8_t value, bool
     // reconfigure timer
     timer_reg[1] |= RTC_TIMER_TE; // enable timer
     if (int_enable)
-        timer_reg[1] |= RTC_TIMER_TIE; // enable interrupr
+        timer_reg[1] |= RTC_TIMER_TIE; // enable interrupt
     if (int_pulse)
         timer_reg[1] |= RTC_TIMER_TI_TP; // interrupt mode
     timer_reg[1] |= source_clock << 3;   // clock source
@@ -792,6 +806,9 @@ void System::rtcReset() // datasheet 8.2.1.3.
 
 /**
  * @brief                   Converts decimal to BCD
+ *
+ * @param                   uint8_t val
+ *                          number which needs to be converted from decimal to Bcd value
  */
 uint8_t System::rtcDecToBcd(uint8_t val)
 {
@@ -800,6 +817,9 @@ uint8_t System::rtcDecToBcd(uint8_t val)
 
 /**
  * @brief                   Converts BCD to decimal
+ *
+ * @param                   uint8_t val
+ *                          number which needs to be converted from Bcd to decimal value
  */
 uint8_t System::rtcBcdToDec(uint8_t val)
 {