From f27cc16d426708c9267dcb290d4a32f2a5dcb686 Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Fri, 9 Dec 2016 13:56:30 +0000
Subject: improve doc comments in windows corewindow handling

---
 frontends/windows/corewindow.c | 11 +++++++++--
 frontends/windows/hotlist.c    |  4 ++++
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/frontends/windows/corewindow.c b/frontends/windows/corewindow.c
index d1d761d94..8d853fb23 100644
--- a/frontends/windows/corewindow.c
+++ b/frontends/windows/corewindow.c
@@ -18,7 +18,7 @@
 
 /**
  * \file
- * win32 generic core window interface.
+ * win32 generic core window implementation.
  *
  * Provides interface for core renderers to a win32 api client area.
  *
@@ -248,7 +248,7 @@ nsw32_corewindow_close(struct nsw32_corewindow *nsw32_cw)
 }
 
 /**
- * callback for hotlist window win32 events
+ * callback for core window win32 events
  *
  * \param hwnd The win32 window handle
  * \param msg The win32 message identifier
@@ -349,6 +349,13 @@ nsw32_cw_scroll_visible(struct core_window *cw, const struct rect *r)
 }
 
 
+/**
+ * Callback from the core to obtain the window viewport dimensions
+ *
+ * \param[in] cw the core window object
+ * \param[out] width to be set to viewport width in px
+ * \param[out] height to be set to viewport height in px
+ */
 static void
 nsw32_cw_get_window_dimensions(struct core_window *cw, int *width, int *height)
 {
diff --git a/frontends/windows/hotlist.c b/frontends/windows/hotlist.c
index 2d236f7ac..88a802f4a 100644
--- a/frontends/windows/hotlist.c
+++ b/frontends/windows/hotlist.c
@@ -36,12 +36,16 @@
 #include "windows/hotlist.h"
 
 
+/**
+ * Hotlist window container for win32.
+ */
 struct nsw32_hotlist_window {
 	struct nsw32_corewindow core;
 
 	const char *path; /**< path to users bookmarks */
 };
 
+/** hotlist window singleton */
 static struct nsw32_hotlist_window *hotlist_window = NULL;
 
 /**
-- 
cgit v1.2.3