From 9346694445e49afc07049c8c28015098b2223e23 Mon Sep 17 00:00:00 2001 From: mvglasow Date: Sun, 24 Jan 2016 16:04:14 +0100 Subject: Refactor:gui_internal:Document gui_internal_menu.c Signed-off-by: mvglasow --- navit/gui/internal/gui_internal_menu.c | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/navit/gui/internal/gui_internal_menu.c b/navit/gui/internal/gui_internal_menu.c index 7769953b9..854571195 100644 --- a/navit/gui/internal/gui_internal_menu.c +++ b/navit/gui/internal/gui_internal_menu.c @@ -91,6 +91,21 @@ gui_internal_prune_menu_count(struct gui_priv *this, int count, int render) } } + +/** + * @brief Initializes a GUI screen + * + * This method initializes the internal GUI's screen on which all other elements (such as HTML menus, + * dialogs or others) are displayed. + * + * It sets up a view hierarchy, which includes a title bar and a client area to hold widgets defined by + * the caller. + * + * @param this The GUI instance + * @param label The label to display in the top bar + * + * @return The container for caller-defined widgets + */ struct widget * gui_internal_menu(struct gui_priv *this, const char *label) { -- cgit v1.2.1