summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamien Lespiau <damien.lespiau@intel.com>2012-12-30 17:37:18 +0000
committerRobert Bragg <robert@linux.intel.com>2013-01-21 14:20:36 +0000
commite43b60fb91935813b805611679573ebcf403ddac (patch)
tree859354f360c32e93c689b92ca4da8d7381a5d37f
parent8c89c09b9f5744bd693b8d8cfdb1ec8fd46a4b74 (diff)
downloadcogl-e43b60fb91935813b805611679573ebcf403ddac.tar.gz
doc: Finish describing the arguments of cogl_error_matches()
(cherry picked from commit 8f429d9ce45e3df204db0bdc0d988fd07f103282)
-rw-r--r--cogl/cogl-error.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/cogl/cogl-error.h b/cogl/cogl-error.h
index 1015ca12..f5867899 100644
--- a/cogl/cogl-error.h
+++ b/cogl/cogl-error.h
@@ -146,8 +146,10 @@ cogl_error_copy (CoglError *error);
/**
* cogl_error_matches:
* @error: A #CoglError thrown by the Cogl api or %NULL
+ * @domain: The error domain
+ * @code: The error code
*
- * Returns %TRUE if error matches domain and code, %FALSE otherwise.
+ * Returns %TRUE if error matches @domain and @code, %FALSE otherwise.
* In particular, when error is %NULL, FALSE will be returned.
*
* Return value: whether the @error corresponds to the given @domain