Doxygen update
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@428 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
@@ -107,6 +107,7 @@ struct DisplayDevice
|
||||
* If a specific function is not implemented at the display device it is valid
|
||||
* to use NULL pointer instead
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
* @param parameters Parameters for the display device
|
||||
* @param reset Pointer to DISPLAY RESET function
|
||||
@@ -151,6 +152,7 @@ extern ErrorStatus DisplayDevice_construct (struct DisplayDevice* self, struct D
|
||||
* DisplayDevice_destruct
|
||||
* Destructor for Display Device
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance to destruct
|
||||
*
|
||||
* @return void
|
||||
@@ -165,6 +167,7 @@ extern void DisplayDevice_destruct (struct DisplayDevice* self);
|
||||
* DisplayDevice_reset
|
||||
* RESET the complete display device
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
*
|
||||
* @return ErrorStatus SUCCESS if function was successful
|
||||
@@ -181,6 +184,7 @@ extern ErrorStatus DisplayDevice_reset(const struct DisplayDevice* self);
|
||||
* Sets the display to new state
|
||||
*
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
* @param state Can be either ON or OFF
|
||||
*
|
||||
@@ -198,6 +202,7 @@ extern ErrorStatus DisplayDevice_setState(const struct DisplayDevice* self, Disp
|
||||
* Display backspace function. Set cursor one position back and delete character
|
||||
*
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
*
|
||||
* @return ErrorStatus SUCCESS if function was successful
|
||||
@@ -215,6 +220,7 @@ extern ErrorStatus DisplayDevice_backspace(const struct DisplayDevice* self);
|
||||
* DisplayDevice function in behind verifies the position
|
||||
*
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
* @param row Row to use (starts with 1, not 0)
|
||||
* @param column Column to use (Starts with 1, not 0)
|
||||
@@ -235,6 +241,7 @@ extern ErrorStatus DisplayDevice_setCursorToPosition(const struct DisplayDevice*
|
||||
* arguments row/column
|
||||
*
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
* @param buffer Pointer to the character to write
|
||||
* @param row Row to use (starts with 1, not 0)
|
||||
@@ -254,6 +261,7 @@ extern ErrorStatus DisplayDevice_writeCharacter(const struct DisplayDevice* self
|
||||
* DisplayDevice_write
|
||||
*
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
* @param buffer Pointer to the string to write
|
||||
* @param length The length (number in characters) of the
|
||||
@@ -277,6 +285,7 @@ extern ErrorStatus DisplayDevice_write(const struct DisplayDevice* self, const c
|
||||
* Function to clear the complete display
|
||||
*
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
*
|
||||
* @return ErrorStatus SUCCESS if function was successful
|
||||
@@ -293,6 +302,7 @@ extern ErrorStatus DisplayDevice_clear(const struct DisplayDevice* self);
|
||||
* Function to clear the line given in argument row
|
||||
*
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
* @param row Row to use (starts with 1, not 0)
|
||||
*
|
||||
@@ -313,6 +323,7 @@ extern ErrorStatus DisplayDevice_clearLine(const struct DisplayDevice* self, uns
|
||||
* parameters in the constructor
|
||||
*
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
* @param brightness The brightness value
|
||||
*
|
||||
@@ -333,6 +344,7 @@ extern ErrorStatus DisplayDevice_setBrightness(const struct DisplayDevice* self,
|
||||
* Must be a value between the min and max contrast given in the display device
|
||||
* parameters in the constructor
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
* @param contrast The contrast value
|
||||
*
|
||||
@@ -352,6 +364,7 @@ extern ErrorStatus DisplayDevice_setContrast(const struct DisplayDevice* self, u
|
||||
* Function to invert the display representation
|
||||
*
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
*
|
||||
* @return ErrorStatus SUCCESS if function was successful
|
||||
@@ -368,6 +381,7 @@ extern ErrorStatus DisplayDevice_invert(const struct DisplayDevice* self);
|
||||
* Sets the state for a blinking cursor
|
||||
*
|
||||
*
|
||||
* @memberof DisplayDevice
|
||||
* @param self The device instance
|
||||
* @param state Can either be ON or OFF
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user