Got Gtk-Doc working. Now all the fancy /** comments before the functions

[rodin/chimara.git] / src / gestalt.c

diff --git a/src/gestalt.c b/src/gestalt.c
index 0c3d27b855d8a917f545c218b550c0239008acd1..4b3b19c0a3e5af913fdd06b75dea46c78062c0d9 100644 (file)
--- a/src/gestalt.c
+++ b/src/gestalt.c
@@ -33,32 +33,31 @@ glk_gestalt(glui32 sel, glui32 val)
  * Calls the gestalt system to request information about the capabilities of the
  * API. The selector @sel tells which capability you are requesting information
  * about; the other three arguments are additional information, which may or may
- * not be meaningful. The @arr and @arrlen arguments are always optional; you
- * may always pass %NULL and 0, if you do not want whatever information they
- * represent. glk_gestalt() is simply a shortcut for this; glk_gestalt(x, y) is
- * exactly the same as glk_gestalt_ext(x, y, NULL, 0).
+ * not be meaningful. The @arr and @arrlen arguments of glk_gestalt_ext() are
+ * always optional; you may always pass %NULL and 0, if you do not want whatever
+ * information they represent. glk_gestalt() is simply a shortcut for this;
+ * <code>#glk_gestalt(x, y)</code> is exactly the same as 
+ * <code>#glk_gestalt_ext(x, y, %NULL, 0)</code>.
  *
  * The critical point is that if the Glk library has never heard of the selector
- * sel, it will return 0. It is always safe to call glk_gestalt(x, y) (or
- * glk_gestalt_ext(x, y, NULL, 0)). Even if you are using an old library, which
- * was compiled before the given capability was imagined, you can test for the
- * capability by calling glk_gestalt(); the library will correctly indicate that
- * it does not support it, by returning 0.
+ * @sel, it will return 0. It is <emphasis>always</emphasis> safe to call 
+ * <code>#glk_gestalt(x, y)</code> (or <code>#glk_gestalt_ext(x, y, %NULL, 
+ * 0)</code>). Even if you are using an old library, which was compiled before
+ * the given capability was imagined, you can test for the capability by calling
+ * glk_gestalt(); the library will correctly indicate that it does not support
+ * it, by returning 0.
  *
- * <note><para>
- *  It is also safe to call glk_gestalt_ext(x, y, z, zlen) for an unknown 
- *  selector x, where z is not %NULL, as long as z points at an array of at 
- *  least zlen elements. The selector will be careful not to write beyond that  
- *  point in the array, if it writes to the array at all.
- * </para></note>
+ * (It is also safe to call <code>#glk_gestalt_ext(x, y, z, zlen)</code> for an
+ * unknown selector <code>x</code>, where <code>z</code> is not %NULL, as long
+ * as <code>z</code> points at an array of at least <code>zlen</code> elements.
+ * The selector will be careful not to write beyond that point in the array, if
+ * it writes to the array at all.)
  *
- * <note><para>
- *  If a selector does not use the second argument, you should always pass 0; do
- *  not assume that the second argument is simply ignored. This is because the
- *  selector may be extended in the future. You will continue to get the current
- *  behavior if you pass 0 as the second argument, but other values may produce
- *  other behavior.
- * </para></note>
+ * (If a selector does not use the second argument, you should always pass 0; do
+ * not assume that the second argument is simply ignored. This is because the
+ * selector may be extended in the future. You will continue to get the current
+ * behavior if you pass 0 as the second argument, but other values may produce
+ * other behavior.)
  *
  * Returns: an integer, depending on what selector was called.
  */