aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-exception.c
diff options
context:
space:
mode:
Diffstat (limited to 'camel/camel-exception.c')
-rw-r--r--camel/camel-exception.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/camel/camel-exception.c b/camel/camel-exception.c
index 9a20dd2838..cf5daff9d3 100644
--- a/camel/camel-exception.c
+++ b/camel/camel-exception.c
@@ -153,7 +153,8 @@ camel_exception_set (CamelException *ex,
* camel_exception_setv: set an exception
* @ex: exception object
* @id: exception id
- * @format: format of the description string. The format string is used as in printf().
+ * @format: format of the description string. The format string is
+ * used as in printf().
*
* Set the value of an exception. The exception id is
* a unique number representing the exception. The
@@ -162,6 +163,9 @@ camel_exception_set (CamelException *ex,
* In this version, the string is created from the format
* string and the variable argument list.
*
+ * It is safe to say:
+ * camel_exception_setv (ex, ..., camel_exception_get_description (ex), ...);
+ *
* When @ex is NULL, nothing is done, this routine
* simply returns.
*