docs: Partially document the liblttng-ctl C API

[lttng-tools.git] / include / lttng / constant.h

diff --git a/include/lttng/constant.h b/include/lttng/constant.h
index 2cbb4609566c174a7e5de91d3407608855ad4248..f20e96458f795335aacdba6ccdc0a62b4f6e9b12 100644 (file)
--- a/include/lttng/constant.h
+++ b/include/lttng/constant.h
@@ -33,6 +33,13 @@
 /*
  * Event symbol length. Copied from LTTng kernel ABI.
  */
+
+/*!
+@brief
+    Maximum symbol length.
+
+@ingroup api_gen
+*/
 #define LTTNG_SYMBOL_NAME_LEN 256
 
 /*
@@ -42,6 +49,12 @@
 #define LTTNG_MAX_PID    INT32_MAX
 #define LTTNG_MAX_PID_STR "2147483647"
 
+/*!
+@brief
+    Maximum name length.
+
+@ingroup api_gen
+*/
 #define LTTNG_NAME_MAX 255
 
 /*