X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;ds=sidebyside;f=src%2Fgestalt.c;h=4b3b19c0a3e5af913fdd06b75dea46c78062c0d9;hb=3c7e09ffabd2962b5345c906b4d46757b796a4da;hp=0c3d27b855d8a917f545c218b550c0239008acd1;hpb=8bf874cd9d56a5850bc474df37642170a4c20b28;p=rodin%2Fchimara.git
diff --git a/src/gestalt.c b/src/gestalt.c
index 0c3d27b..4b3b19c 100644
--- 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;
+ * #glk_gestalt(x, y)
is exactly the same as
+ * #glk_gestalt_ext(x, y, %NULL, 0)
.
*
* 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 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.
*
- *
- * 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.
- *
+ * (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.)
*
- *
- * 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.
- *
+ * (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.
*/