summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormvglasow <michael -at- vonglasow.com>2016-01-19 20:25:12 +0100
committermvglasow <michael -at- vonglasow.com>2016-01-19 20:25:12 +0100
commite38b33546d2f7ee631b7da603c8fa894034c435e (patch)
treeec9c0dd1050b313d69e3d590eca1bd27afa9a2b1
parent59f741f634cab4529867e4296276337f03fa8b87 (diff)
downloadnavit-e38b33546d2f7ee631b7da603c8fa894034c435e.tar.gz
Refactor:core:Document window.hR6537
Signed-off-by: mvglasow <michael -at- vonglasow.com>
-rw-r--r--navit/window.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/navit/window.h b/navit/window.h
index b2e2acb7a..706bea798 100644
--- a/navit/window.h
+++ b/navit/window.h
@@ -17,8 +17,11 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * Describes the Navit application window or equivalent.
+ */
struct window {
- void *priv;
- int (*fullscreen)(struct window *win, int on);
- void (*disable_suspend)(struct window *win);
+ void *priv; /**< Private data of the graphics implementation */
+ int (*fullscreen)(struct window *win, int on); /**< Method to toggle fullscreen mode */
+ void (*disable_suspend)(struct window *win); /**< Method to disable suspend mode or screen savers */
};