[vlc-commits] window: document vout_window_cfg_t

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sun Dec  2 13:21:07 2018 +0200| [bb0c1c2380afc2a0b9d54d66dbf9ee630a01f377] | committer: Rémi Denis-Courmont

window: document vout_window_cfg_t

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=bb0c1c2380afc2a0b9d54d66dbf9ee630a01f377
---

 include/vlc_vout_window.h | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/include/vlc_vout_window.h b/include/vlc_vout_window.h
index 36279d556d..d02cc93c44 100644
--- a/include/vlc_vout_window.h
+++ b/include/vlc_vout_window.h
@@ -93,8 +93,21 @@ typedef struct vout_window_mouse_event_t
     int button_mask;
 } vout_window_mouse_event_t;
 
+/**
+ * Window (desired) configuration.
+ *
+ * This structure describes the intended initial configuration
+ * of a \ref vout_window_t.
+ */
 typedef struct vout_window_cfg_t {
+    /**
+     * Whether the window should be in full screen mode or not.
+     */
     bool is_fullscreen;
+
+    /**
+     * Whether the window should have decorations or not.
+     */
     bool is_decorated;
 
 #ifdef __APPLE__
@@ -103,8 +116,14 @@ typedef struct vout_window_cfg_t {
     int y;
 #endif
 
-    /* Windows size hint */
+    /**
+     * Intended pixel width of the window.
+     */
     unsigned width;
+
+    /**
+     * Intended pixel height of the window.
+     */
     unsigned height;
 
 } vout_window_cfg_t;