Update docs for window borders
authorP. F. Chimento <philip.chimento@gmail.com>
Thu, 21 Apr 2011 10:55:30 +0000 (12:55 +0200)
committerP. F. Chimento <philip.chimento@gmail.com>
Thu, 21 Apr 2011 10:55:30 +0000 (12:55 +0200)
libchimara/chimara-glk.c
libchimara/doc.c

index 7b4a63d0ac2a9ea7a4aca9dd74776d93c7f8eae1..86522e53ace85d1019a0ade6c41d806ea4bc685e 100644 (file)
@@ -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"),
index 1d99af1faf38b1c3e46eb2d1fa7aa13195b9a29e..4b0a273f1a5567f583c047ade0d80f12b4e14400 100644 (file)
  * 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>
  */
 
 /**