From 33bba36821a29e0e7a0f3b716be674cf14d87d20 Mon Sep 17 00:00:00 2001 From: Ran Benita Date: Tue, 23 Oct 2012 10:25:26 +0200 Subject: doc: move include_path functions to a separate group 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 --- xkbcommon/xkbcommon.h | 63 +++++++++++++++++++++++++++++++-------------------- 1 file changed, 38 insertions(+), 25 deletions(-) (limited to 'xkbcommon') diff --git a/xkbcommon/xkbcommon.h b/xkbcommon/xkbcommon.h index f4c34fc..f046fdb 100644 --- a/xkbcommon/xkbcommon.h +++ b/xkbcommon/xkbcommon.h @@ -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); - /** @} */ /** -- cgit v1.2.3