alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-03 18:31:13 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: updated @param tags, added missing function descriptions, other minor changes

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2017-04-10 16:59:39 -07:00
parent 39df7fd10f
commit 3aef2ea70e
94 changed files with 327 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/lcd/eboled.hpp
View File

@ -121,7 +121,6 @@ namespace upm
* @param spi spi bus to use
* @param CD Command/Data select pin
* @param reset reset pin
* @param address the slave address the lcd is registered on
*/
EBOLED(int spi=EBOLED_DEFAULT_SPI_BUS, int CD=EBOLED_DEFAULT_CD,
int reset=EBOLED_DEFAULT_RESET);
@ -150,8 +149,8 @@ namespace upm
/**
* Set cursor to a coordinate
*
* @param y Axis on the vertical scale. This device supports 6 rows.
* @param x Axis on the horizontal scale This device supports 64 columns
* @param row Axis on the vertical scale. This device supports 6 rows.
* @param column Axis on the horizontal scale This device supports 64 columns
*
* @return result of operation
*/
@ -185,7 +184,6 @@ namespace upm
* @param y Axis on the vertical scale
* @param data Character to write
* @param color Character color
* @param bg Character background color
* @param size Size of the font
*/
void drawChar (uint8_t x, uint8_t y, uint8_t data, uint8_t color, uint8_t size);
@ -242,7 +240,7 @@ namespace upm
*
* @param x the x position of the beginning of the line
* @param y the y position of the beginning of the line
* @param width is the vertical length of the line
* @param height is the vertical length of the line
* @param color line is COLOR_WHITE, COLOR_BLACK or COLOR_XOR
*/
void drawLineVertical (int8_t x, int8_t y, uint8_t height, uint8_t color = COLOR_WHITE);

2
src/lcd/ssd1327.hpp
View File

@ -78,7 +78,7 @@ class SSD1327 : public LCD
/**
* Sets the gray level for the LCD panel
*
* @param gray level from 0 to 255
* @param level level from 0 to 255
* @return Result of the operation
*/
void setGrayLevel(uint8_t level);