From f68a3f9d61bf66640071ec2f32f7b2ed09215a87 Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Sat, 24 Dec 2016 23:23:30 +0000
Subject: improve gtk corewindow documentation

---
 frontends/gtk/corewindow.c | 24 ++++++++++--------------
 frontends/gtk/hotlist.c    |  3 +++
 2 files changed, 13 insertions(+), 14 deletions(-)

(limited to 'frontends')

diff --git a/frontends/gtk/corewindow.c b/frontends/gtk/corewindow.c
index a9926012b..9f66ef1ca 100644
--- a/frontends/gtk/corewindow.c
+++ b/frontends/gtk/corewindow.c
@@ -620,11 +620,11 @@ nsgtk_cw_scroll_visible(struct core_window *cw, const struct rect *r)
 
 
 /**
- * get window size core window callback
+ * Callback from the core to obtain the window viewport dimensions
  *
- * \param cw core window handle.
- * \param[out] width The width value to update
- * \param[out] height The height value to update
+ * \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
 nsgtk_cw_get_window_dimensions(struct core_window *cw, int *width, int *height)
@@ -634,17 +634,13 @@ nsgtk_cw_get_window_dimensions(struct core_window *cw, int *width, int *height)
 	GtkAdjustment *hadj;
 	gdouble page;
 
-	if (width != NULL) {
-		hadj = gtk_scrolled_window_get_hadjustment(nsgtk_cw->scrolled);
-		g_object_get(hadj, "page-size", &page, NULL);
-		*width = page;
-	}
+	hadj = gtk_scrolled_window_get_hadjustment(nsgtk_cw->scrolled);
+	g_object_get(hadj, "page-size", &page, NULL);
+	*width = page;
 
-	if (height != NULL) {
-		vadj = gtk_scrolled_window_get_vadjustment(nsgtk_cw->scrolled);
-		g_object_get(vadj, "page-size", &page, NULL);
-		*height = page;
-	}
+	vadj = gtk_scrolled_window_get_vadjustment(nsgtk_cw->scrolled);
+	g_object_get(vadj, "page-size", &page, NULL);
+	*height = page;
 }
 
 
diff --git a/frontends/gtk/hotlist.c b/frontends/gtk/hotlist.c
index c47d1da3f..f64600a5b 100644
--- a/frontends/gtk/hotlist.c
+++ b/frontends/gtk/hotlist.c
@@ -38,6 +38,9 @@
 #include "gtk/corewindow.h"
 #include "gtk/hotlist.h"
 
+/**
+ * hotlist window container for gtk.
+ */
 struct nsgtk_hotlist_window {
 	struct nsgtk_corewindow core;
 	GtkBuilder *builder;
-- 
cgit v1.2.3