From: P. F. Chimento <philip.chimento@gmail.com>
Date: Thu, 21 Apr 2011 10:55:30 +0000 (+0200)
Subject: Update docs for window borders
X-Git-Tag: v0.9~91
X-Git-Url: https://git.stderr.nl/gitweb?p=projects%2Fchimara%2Fchimara.git;a=commitdiff_plain;h=2dea59cff08d5cd7654fbf470db7f4512608dc58

Update docs for window borders
---

diff --git a/libchimara/chimara-glk.c b/libchimara/chimara-glk.c
index 7b4a63d..86522e5 100644
--- a/libchimara/chimara-glk.c
+++ b/libchimara/chimara-glk.c
@@ -861,7 +861,10 @@ chimara_glk_class_init(ChimaraGlkClass *klass)
 	/**
 	 * ChimaraGlk:spacing:
 	 *
-	 * The amount of space between the Glk windows.
+	 * The amount of space between the Glk windows. This space forms a visible
+	 * border between windows; however, if you open a window using the
+	 * %winmethod_NoBorder flag, there will be no spacing between it and its
+	 * sibling window, no matter what the value of this property is.
 	 */
 	g_object_class_install_property(object_class, PROP_SPACING,
 		g_param_spec_uint("spacing", _("Spacing"),
diff --git a/libchimara/doc.c b/libchimara/doc.c
index 1d99af1..4b0a273 100644
--- a/libchimara/doc.c
+++ b/libchimara/doc.c
@@ -2532,6 +2532,12 @@
  * When calling glk_window_open() with this @method, it specifies that there
  * should be a visible window border between the new window and its sibling.
  * (This is a hint to the library.)
+ *
+ * <note><title>Chimara</title><para>
+ *   There will only be a visible border if the #ChimaraGlk:spacing property
+ *   is nonzero. Setting #ChimaraGlk:spacing to zero disables all borders on Glk
+ *   windows.
+ * </para></note>
  */
 
 /**