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

docs: more header files edited

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/lol/lol.h
View File

@ -34,7 +34,7 @@ namespace upm {
#define LOL_Y 9
/**
* @brief Olimex LoL array library
* @brief Olimex LoL Array library
* @defgroup lol libupm-lol
* @ingroup adafruit gpio display
*/
@ -42,14 +42,14 @@ namespace upm {
/**
* @library lol
* @sensor lol
* @comname Olimex LoL LED Array
* @comname Olimex LoL Array
* @type display
* @man adafruit
* @con gpio
*
* @brief API for Olimex LoL array
* @brief API for the Olimex LoL array
*
* This file defines the LoL API and implementation for a simple frame buffer.
* This file defines the LoL API and implementation for a simple framebuffer.
*
* @image html lolshield.jpg
* @snippet lol-example.cxx Interesting
@ -57,7 +57,7 @@ namespace upm {
class LoL {
public:
/**
* Instantiates a LoL object
* Instantiates an LoL object
* singleton
*/
LoL();
@ -68,25 +68,25 @@ class LoL {
~LoL();
/**
* Get framebuffer pointer
* @return 0 on success
* Gets a framebuffer pointer
* @return 0 if successful
*/
unsigned char *getFramebuffer();
/**
* Gets pixel at coordinates
* @param x coordinate x
* @param y coordinate y
* @return 1 if pixel is on, 0 if off, -1 on error
* Gets a pixel at specified coordinates
* @param x Coordinate x
* @param y Coordinate y
* @return 1 if the pixel is on, 0 if off, -1 on error
*/
unsigned char getPixel(int x, int y);
/**
* sets pixel at coordinates
* @param x coordinate x
* @param y coordinate y
* Sets a pixel at specified coordinates
* @param x Coordinate x
* @param y Coordinate y
* @param pixel 0 is off, 1 is on
* @return 0 on success, -1 on error
* @return 0 if successful, -1 on error
*/
unsigned char setPixel(int x, int y, unsigned char pixel);