Copyright ownership transfer

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

diff --git a/include/lttng/ust-error.h b/include/lttng/ust-error.h
index de7e665f27655b5563f6d992503d3fafb92845b9..49045babc5402bd1851fc340a27ce7ad12a6e9d7 100644 (file)
--- a/include/lttng/ust-error.h
+++ b/include/lttng/ust-error.h
@@ -1,8 +1,7 @@
 /*
  * SPDX-License-Identifier: LGPL-2.1-only
  *
- * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
- * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
+ * Copyright (C) 2011 EfficiOS Inc.
  * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  */
 
@@ -41,8 +40,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);