Fixed documentation to work with Gtk-Doc 1.14 and produce as few warnings as possible

[rodin/chimara.git] / libchimara / window.c

diff --git a/libchimara/window.c b/libchimara/window.c
index 15f8f4b1337059e2d4452a1c338ca019a0f5c8a4..84b6fd9431b4987b73e7832811d3b664e8418a3f 100644 (file)
--- a/libchimara/window.c
+++ b/libchimara/window.c
@@ -282,11 +282,11 @@ glk_window_get_root()
  * 
  * So to create a text buffer window which takes the top 40% of the original
  * window's space, you would execute
- * |[ newwin = #glk_window_open(win, #winmethod_Above | #winmethod_Proportional, 40, #wintype_TextBuffer, 0); ]|
+ * |[ newwin = glk_window_open(win, winmethod_Above | winmethod_Proportional, 40, wintype_TextBuffer, 0); ]|
  *
  * To create a text grid which is always five lines high, at the bottom of the
  * original window, you would do
- * |[ newwin = #glk_window_open(win, #winmethod_Below | #winmethod_Fixed, 5, #wintype_TextGrid, 0); ]|
+ * |[ newwin = glk_window_open(win, winmethod_Below | winmethod_Fixed, 5, wintype_TextGrid, 0); ]|
  * 
  * Note that the meaning of the @size argument depends on the @method argument.
  * If the method is %winmethod_Fixed, it also depends on the @wintype argument.
@@ -331,7 +331,8 @@ glk_window_get_root()
  * <quote>O</quote>. C gets two rows; A gets the rest. All done.
  * 
  * Then the user maliciously starts squeezing the window down, in stages:
- * <informaltable frame="none"><tgroup cols="5"><tbody><row valign="top">
+ * <informaltable xml:id="chimara-Figure-Squeezing-Window" frame="none">
+ * <tgroup cols="5"><tbody><row valign="top">
  * <entry><mediaobject><imageobject><imagedata fileref="fig5-7a.png"/>
  * </imageobject></mediaobject></entry>
  * <entry><mediaobject><imageobject><imagedata fileref="fig7b.png"/>
@@ -894,7 +895,8 @@ glk_window_close(winid_t win, stream_result_t *result)
  *  <term>Graphics</term>
  *  <listitem><para>
  *   Clears the entire window to its current background color. See <link
- *   linkend="chimara-Graphics-Windows">Graphics Windows</link>.
+ *   linkend="chimara-The-Types-of-Windows&num;wintype-Graphics">Graphics 
+ *   Windows</link>.
  *  </para></listitem>
  * </varlistentry>
  * <varlistentry>
@@ -990,7 +992,7 @@ glk_window_clear(winid_t win)
  * @win: A window, or %NULL.
  *
  * Sets the current stream to @win's window stream. It is exactly equivalent to
- * |[ #glk_stream_set_current(#glk_window_get_stream(@win)) ]| 
+ * |[ glk_stream_set_current(glk_window_get_stream(win)) ]| 
  * See <link linkend="chimara-Streams">Streams</link>.
  *
  * <note><title>Chimara</title>
@@ -1184,15 +1186,15 @@ glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
  * Consider the example above, where D has collapsed to zero height. Say D was a
  * text buffer window. You could make a more useful layout by doing
  * |[
- * #winid_t o2;
- * o2 = #glk_window_get_parent(d);
- * glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 3, d);
+ * winid_t o2;
+ * o2 = glk_window_get_parent(d);
+ * glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 3, d);
  * ]|
  * That would set D (the upper child of O2) to be O2's key window, and give it a
  * fixed size of 3 rows.
  * 
  * If you later wanted to expand D, you could do
- * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Fixed, 5, NULL); ]|
+ * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Fixed, 5, NULL); ]|
  * That expands D to five rows. Note that, since O2's key window is already set 
  * to D, it is not necessary to provide the @keywin argument; you can pass %NULL
  * to mean <quote>leave the key window unchanged.</quote>
@@ -1202,18 +1204,18 @@ glk_window_get_size(winid_t win, glui32 *widthptr, glui32 *heightptr)
  * example, you could change O2's key window to be A, but not B. The key window
  * also cannot be a pair window itself.
  * 
- * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, NULL); ]|
+ * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, NULL); ]|
  * This changes the constraint to be on the <emphasis>lower</emphasis> child of 
  * O2, which is A. The key window is still D; so A would then be three rows high
  * as measured in D's font, and D would get the rest of O2's space. That may not
  * be what you want. To set A to be three rows high as measured in A's font, you
  * would do
- * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Fixed, 3, a); ]|
+ * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Fixed, 3, a); ]|
  * 
  * Or you could change O2 to a proportional split:
- * |[ glk_window_set_arrangement(o2, #winmethod_Below | #winmethod_Proportional, 30, NULL); ]|
+ * |[ glk_window_set_arrangement(o2, winmethod_Below | winmethod_Proportional, 30, NULL); ]|
  * or
- * |[ glk_window_set_arrangement(o2, #winmethod_Above | #winmethod_Proportional, 70, NULL); ]|
+ * |[ glk_window_set_arrangement(o2, winmethod_Above | winmethod_Proportional, 70, NULL); ]|
  * These do exactly the same thing, since 30&percnt; above is the same as 
  * 70&percnt; below. You don't need to specify a key window with a proportional
  * split, so the @keywin argument is %NULL. (You could actually specify either A