Re-implement lttng_ust_strerr

[lttng-ust.git] / include / lttng / ust-error.h

diff --git a/include/lttng/ust-error.h b/include/lttng/ust-error.h
index de7e665f27655b5563f6d992503d3fafb92845b9..543c894af92468283deca38bb1e217c9213b2d4a 100644 (file)
--- a/include/lttng/ust-error.h
+++ b/include/lttng/ust-error.h
@@ -41,8 +41,11 @@ enum lttng_ust_error_code {
 };
 
 /*
- * Return a human-readable error message for an lttng-ust error code.
- * code must be a positive value (or 0).
+ * lttng_ust_strerror
+ * @code: must be a negative value of enum lttng_ust_error_code (or 0).
+ *
+ * Returns a ptr to a string representing a human readable error code from the
+ * ustcomm_return_code enum.
  */
 const char *lttng_ust_strerror(int code);