Skip to content
Snippets Groups Projects
Verified Commit 8b6240f0 authored by rahix's avatar rahix
Browse files

fix(docs): Minor fixes in display docs


Signed-off-by: default avatarRahix <rahix@rahix.de>
parent c3bcca29
No related branches found
No related tags found
No related merge requests found
...@@ -22,9 +22,9 @@ Last but not least, if you want to start hacking the lower-level firmware, the ...@@ -22,9 +22,9 @@ Last but not least, if you want to start hacking the lower-level firmware, the
pycardium/overview pycardium/overview
pycardium/color pycardium/color
pycardium/display
pycardium/leds pycardium/leds
pycardium/vibra pycardium/vibra
pycardium/display
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
......
...@@ -177,19 +177,19 @@ API(API_INTERRUPT_DISABLE, int epic_interrupt_disable(api_int_id_t int_id)); ...@@ -177,19 +177,19 @@ API(API_INTERRUPT_DISABLE, int epic_interrupt_disable(api_int_id_t int_id));
* ======= * =======
*/ */
/** /** Line-Style */
*
*/
enum linestyle_t { enum linestyle_t {
/** */
LINESTYLE_FULL = 0, LINESTYLE_FULL = 0,
/** */
LINESTYLE_DOTTED = 1 LINESTYLE_DOTTED = 1
}; };
/** /** Fill-Style */
*
*/
enum fillstyle_t { enum fillstyle_t {
/** */
FILLSTYLE_EMPTY = 0, FILLSTYLE_EMPTY = 0,
/** */
FILLSTYLE_FILLED = 1 FILLSTYLE_FILLED = 1
}; };
...@@ -197,6 +197,7 @@ enum fillstyle_t { ...@@ -197,6 +197,7 @@ enum fillstyle_t {
* Locks the display. * Locks the display.
* *
* :return: ``0`` on success or a negative value in case of an error: * :return: ``0`` on success or a negative value in case of an error:
*
* - ``-EBUSY``: Display was already locked from another task. * - ``-EBUSY``: Display was already locked from another task.
*/ */
API(API_DISP_OPEN, int epic_disp_open()); API(API_DISP_OPEN, int epic_disp_open());
...@@ -205,6 +206,7 @@ API(API_DISP_OPEN, int epic_disp_open()); ...@@ -205,6 +206,7 @@ API(API_DISP_OPEN, int epic_disp_open());
* Unlocks the display again. * Unlocks the display again.
* *
* :return: ``0`` on success or a negative value in case of an error: * :return: ``0`` on success or a negative value in case of an error:
*
* - ``-EBUSY``: Display was already locked from another task. * - ``-EBUSY``: Display was already locked from another task.
*/ */
API(API_DISP_CLOSE, int epic_disp_close()); API(API_DISP_CLOSE, int epic_disp_close());
...@@ -224,6 +226,7 @@ API(API_DISP_UPDATE, int epic_disp_update()); ...@@ -224,6 +226,7 @@ API(API_DISP_UPDATE, int epic_disp_update());
* :param fg: foreground color in rgb565 * :param fg: foreground color in rgb565
* :param bg: background color in rgb565 * :param bg: background color in rgb565
* :return: ``0`` on success or a negative value in case of an error: * :return: ``0`` on success or a negative value in case of an error:
*
* - ``-EBUSY``: Display was already locked from another task. * - ``-EBUSY``: Display was already locked from another task.
*/ */
API(API_DISP_PRINT, API(API_DISP_PRINT,
...@@ -240,6 +243,7 @@ API(API_DISP_PRINT, ...@@ -240,6 +243,7 @@ API(API_DISP_PRINT,
* *
* :param color: fill color in rgb565 * :param color: fill color in rgb565
* :return: ``0`` on success or a negative value in case of an error: * :return: ``0`` on success or a negative value in case of an error:
*
* - ``-EBUSY``: Display was already locked from another task. * - ``-EBUSY``: Display was already locked from another task.
*/ */
API(API_DISP_CLEAR, int epic_disp_clear(uint16_t color)); API(API_DISP_CLEAR, int epic_disp_clear(uint16_t color));
...@@ -255,6 +259,7 @@ API(API_DISP_CLEAR, int epic_disp_clear(uint16_t color)); ...@@ -255,6 +259,7 @@ API(API_DISP_CLEAR, int epic_disp_clear(uint16_t color));
* :param linestyle: 0 for solid, 1 for dottet (almost no visual difference) * :param linestyle: 0 for solid, 1 for dottet (almost no visual difference)
* :param pixelsize: thickness of the line; 1 <= pixelsize <= 8 * :param pixelsize: thickness of the line; 1 <= pixelsize <= 8
* :return: ``0`` on success or a negative value in case of an error: * :return: ``0`` on success or a negative value in case of an error:
*
* - ``-EBUSY``: Display was already locked from another task. * - ``-EBUSY``: Display was already locked from another task.
*/ */
API(API_DISP_LINE, API(API_DISP_LINE,
...@@ -279,6 +284,7 @@ API(API_DISP_LINE, ...@@ -279,6 +284,7 @@ API(API_DISP_LINE,
* :param fillstyle: 0 for empty, 1 for filled * :param fillstyle: 0 for empty, 1 for filled
* :param pixelsize: thickness of the rectangle outline; 1 <= pixelsize <= 8 * :param pixelsize: thickness of the rectangle outline; 1 <= pixelsize <= 8
* :return: ``0`` on success or a negative value in case of an error: * :return: ``0`` on success or a negative value in case of an error:
*
* - ``-EBUSY``: Display was already locked from another task. * - ``-EBUSY``: Display was already locked from another task.
*/ */
API(API_DISP_RECT, API(API_DISP_RECT,
...@@ -302,6 +308,7 @@ API(API_DISP_RECT, ...@@ -302,6 +308,7 @@ API(API_DISP_RECT,
* :param fillstyle: 0 for empty, 1 for filled * :param fillstyle: 0 for empty, 1 for filled
* :param pixelsize: thickness of the circle outline; 1 <= pixelsize <= 8 * :param pixelsize: thickness of the circle outline; 1 <= pixelsize <= 8
* :return: ``0`` on success or a negative value in case of an error: * :return: ``0`` on success or a negative value in case of an error:
*
* - ``-EBUSY``: Display was already locked from another task. * - ``-EBUSY``: Display was already locked from another task.
*/ */
API(API_DISP_CIRC, API(API_DISP_CIRC,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment