Update docs and fix bugs (#149)
Improved the docs for the 3 main Tactility projects. I also fixed some inaccuracies and bugs in certain APIs as I went through the code.
This commit is contained in:
committed by
GitHub
parent
ff4287e2ce
commit
415096c3b2
@@ -9,12 +9,11 @@ typedef struct Gui Gui;
|
||||
|
||||
/**
|
||||
* Set the app viewport in the gui state and request the gui to draw it.
|
||||
*
|
||||
* @param app
|
||||
* @param on_show
|
||||
* @param on_hide
|
||||
* @param[in] app
|
||||
* @param[in] onShow
|
||||
* @param[in] onHide
|
||||
*/
|
||||
void showApp(app::AppContext& app, ViewPortShowCallback on_show, ViewPortHideCallback on_hide);
|
||||
void showApp(app::AppContext& app, ViewPortShowCallback onShow, ViewPortHideCallback onHide);
|
||||
|
||||
/**
|
||||
* Hide the current app's viewport.
|
||||
@@ -25,7 +24,7 @@ void hideApp();
|
||||
|
||||
/**
|
||||
* Show the on-screen keyboard.
|
||||
* @param textarea the textarea to focus the input for
|
||||
* @param[in] textarea the textarea to focus the input for
|
||||
*/
|
||||
void keyboardShow(lv_obj_t* textarea);
|
||||
|
||||
@@ -47,7 +46,7 @@ bool keyboardIsEnabled();
|
||||
* Glue code for the on-screen keyboard and the hardware keyboard:
|
||||
* - Attach automatic hide/show parameters for the on-screen keyboard.
|
||||
* - Registers the textarea to the default lv_group_t for hardware keyboards.
|
||||
* @param textarea
|
||||
* @param[in] textarea
|
||||
*/
|
||||
void keyboardAddTextArea(lv_obj_t* textarea);
|
||||
|
||||
|
||||
@@ -26,26 +26,22 @@ typedef struct ViewPort {
|
||||
} ViewPort;
|
||||
|
||||
/** ViewPort allocator
|
||||
*
|
||||
* always returns view_port or stops system if not enough memory.
|
||||
* @param app
|
||||
* @param on_show Called to create LVGL widgets
|
||||
* @param on_hide Called before clearing the LVGL widget parent
|
||||
*
|
||||
* @return ViewPort instance
|
||||
* @param onShow Called to create LVGL widgets
|
||||
* @param onHide Called before clearing the LVGL widget parent
|
||||
* @return ViewPort instance
|
||||
*/
|
||||
ViewPort* view_port_alloc(
|
||||
app::AppContext& app,
|
||||
ViewPortShowCallback on_show,
|
||||
ViewPortHideCallback on_hide
|
||||
ViewPortShowCallback onShow,
|
||||
ViewPortHideCallback onHide
|
||||
);
|
||||
|
||||
/** ViewPort deallocator
|
||||
*
|
||||
/** ViewPort destruction
|
||||
* Ensure that view_port was unregistered in GUI system before use.
|
||||
*
|
||||
* @param view_port ViewPort instance
|
||||
* @param viewPort ViewPort instance
|
||||
*/
|
||||
void view_port_free(ViewPort* view_port);
|
||||
void view_port_free(ViewPort* viewPort);
|
||||
|
||||
} // namespace
|
||||
|
||||
Reference in New Issue
Block a user