assert-pre-internal.h: add BT_ASSERT_PRE_VALID_INDEX()

[babeltrace.git] / include / babeltrace / ctf-ir / utils.h

diff --git a/include/babeltrace/ctf-ir/utils.h b/include/babeltrace/ctf-ir/utils.h
index 83d6db7666a47ea650b3b19638f2f86501d15c89..c93b0d8442c8b2fdef4a799a5facc516e389f3d5 100644 (file)
--- a/include/babeltrace/ctf-ir/utils.h
+++ b/include/babeltrace/ctf-ir/utils.h
@@ -30,6 +30,9 @@
  * http://www.efficios.com/ctf
  */
 
+/* For bt_bool */
+#include <babeltrace/types.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -39,6 +42,10 @@ extern "C" {
 @ingroup ctfir
 @brief CTF IR utilities.
 
+@code
+#include <babeltrace/ctf-ir/utils.h>
+@endcode
+
 @file
 @brief CTF IR utilities functions.
 @sa ctfirutils
@@ -55,12 +62,12 @@ This function returns a negative value if \p identifier is a CTF keyword
 or if it does not meet any other imposed requirement.
 
 @param[in] identifier  String to test.
-@returns               0 if \p identifier is a valid identifier, or
-                       a negative value otherwise or on error.
+@returns               #BT_TRUE if \p identifier is a valid CTF
+                       identifier, or #BT_FALSE otherwise.
 
 @prenotnull{identifier}
 */
-extern int bt_ctf_validate_identifier(const char *identifier);
+extern bt_bool bt_identifier_is_valid(const char *identifier);
 
 /** @} */