From e75865264c1afaa1e80f436f780ae7c83925f984 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Tue, 22 Nov 2016 14:48:39 -0500 Subject: [PATCH] Document utils.h (API) MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- include/babeltrace/ctf-ir/utils.h | 41 +++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 13 deletions(-) diff --git a/include/babeltrace/ctf-ir/utils.h b/include/babeltrace/ctf-ir/utils.h index d661ed88f..83d6db766 100644 --- a/include/babeltrace/ctf-ir/utils.h +++ b/include/babeltrace/ctf-ir/utils.h @@ -34,21 +34,36 @@ extern "C" { #endif -/* - * bt_ctf_validate_identifier: validate an identifier against the CTF spec. - * - * Validate that an identifier meets the CTF specification's restrictions on - * identifiers. An identifier will be rejected if it is a keyword defined - * in the CTF specification or if it does not meet any other requirement imposed - * on identifiers. - * - * Note that this will not check whether or not the identifier clashes with - * identifiers used in a given trace. - * - * Returns 0 if the identifier is valid, a negative value on error. - */ +/** +@defgroup ctfirutils CTF IR utilities +@ingroup ctfir +@brief CTF IR utilities. + +@file +@brief CTF IR utilities functions. +@sa ctfirutils + +@addtogroup ctfirutils +@{ +*/ + +/** +@brief Returns whether or not the string \p identifier is a valid + identifier according to CTF. + +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. + +@prenotnull{identifier} +*/ extern int bt_ctf_validate_identifier(const char *identifier); +/** @} */ + #ifdef __cplusplus } #endif -- 2.34.1