doc: move include_path functions to a separate group
authorRan Benita <ran234@gmail.com>
Tue, 23 Oct 2012 08:25:26 +0000 (10:25 +0200)
committerRan Benita <ran234@gmail.com>
Tue, 23 Oct 2012 15:22:13 +0000 (17:22 +0200)
These are 'special intrest' function, like the logging functions, so
it's nice to have them in their own logical group.

Signed-off-by: Ran Benita <ran234@gmail.com>
xkbcommon/xkbcommon.h

index f4c34fce5734367491853a59c40483caecbc4894..f046fdbfc120e2d40244641d11d41dd83282d625 100644 (file)
@@ -444,6 +444,44 @@ xkb_context_ref(struct xkb_context *context);
 void
 xkb_context_unref(struct xkb_context *context);
 
+/**
+ * Store custom user data in the context.
+ *
+ * This may be useful in conjuction with xkb_context_set_log_fn() or other
+ * callbacks.
+ *
+ * @memberof xkb_context
+ */
+void
+xkb_context_set_user_data(struct xkb_context *context, void *user_data);
+
+/**
+ * Retrieves stored user data from the context.
+ *
+ * @returns The stored user data.  If the user data wasn't set, or the
+ * passed in context is NULL, returns NULL.
+ *
+ * This may be useful to access private user data from callbacks like a
+ * custom logging function.
+ *
+ * @memberof xkb_context
+ **/
+void *
+xkb_context_get_user_data(struct xkb_context *context);
+
+/** @} */
+
+/**
+ * @defgroup include-path Include Paths
+ * Manipulating the include paths in a context.
+ *
+ * The include paths are the file-system paths that are searched when an
+ * include statement is encountered during keymap compilation.
+ * In most cases, the default include paths are sufficient.
+ *
+ * @{
+ */
+
 /**
  * Append a new entry to the context's include path.
  *
@@ -505,31 +543,6 @@ xkb_context_num_include_paths(struct xkb_context *context);
 const char *
 xkb_context_include_path_get(struct xkb_context *context, unsigned int index);
 
-/**
- * Store custom user data in the context.
- *
- * This may be useful in conjuction with xkb_context_set_log_fn() or other
- * callbacks.
- *
- * @memberof xkb_context
- */
-void
-xkb_context_set_user_data(struct xkb_context *context, void *user_data);
-
-/**
- * Retrieves stored user data from the context.
- *
- * @returns The stored user data.  If the user data wasn't set, or the
- * passed in context is NULL, returns NULL.
- *
- * This may be useful to access private user data from callbacks like a
- * custom logging function.
- *
- * @memberof xkb_context
- **/
-void *
-xkb_context_get_user_data(struct xkb_context *context);
-
 /** @} */
 
 /**