lib: remove "For *" comments in public headers

[babeltrace.git] / include / babeltrace2 / trace-ir / field-class-const.h

diff --git a/include/babeltrace2/trace-ir/field-class-const.h b/include/babeltrace2/trace-ir/field-class-const.h
index b07ee4b615880ad27957649df672f94a53106baa..e7597621d3f19388b1b11c639b6e516de672f777 100644 (file)
--- a/include/babeltrace2/trace-ir/field-class-const.h
+++ b/include/babeltrace2/trace-ir/field-class-const.h
@@ -1,5 +1,5 @@
-#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
-#define BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
+#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
+#define BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
 
 /*
  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
@@ -27,27 +27,19 @@
  * http://www.efficios.com/ctf
  */
 
-/*
- * For bt_bool, bt_field_class, bt_field_path,
- * bt_field_class_enumeration_mapping,
- * bt_field_class_unsigned_enumeration_mapping,
- * bt_field_class_signed_enumeration_mapping,
- * bt_field_class_enumeration_mapping_label_array, __BT_UPCAST_CONST
- */
-#include <babeltrace2/types.h>
+#ifndef __BT_IN_BABELTRACE_H
+# error "Please include <babeltrace2/babeltrace.h> instead."
+#endif
 
 #include <stdint.h>
 #include <stddef.h>
 
+#include <babeltrace2/types.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-typedef enum bt_field_class_status {
-       BT_FIELD_CLASS_STATUS_OK = 0,
-       BT_FIELD_CLASS_STATUS_NOMEM = -12,
-} bt_field_class_status;
-
 typedef enum bt_field_class_type {
        BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
        BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
@@ -124,14 +116,19 @@ bt_field_class_signed_enumeration_mapping_get_range_by_index(
                const bt_field_class_signed_enumeration_mapping *mapping,
                uint64_t index, int64_t *lower, int64_t *upper);
 
-extern bt_field_class_status
-bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
+typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
+       BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
+       BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK                = __BT_FUNC_STATUS_OK,
+} bt_field_class_enumeration_get_mapping_labels_for_value_status;
+
+extern bt_field_class_enumeration_get_mapping_labels_for_value_status
+bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
                const bt_field_class *field_class, uint64_t value,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count);
 
-extern bt_field_class_status
-bt_field_class_signed_enumeration_get_mapping_labels_by_value(
+extern bt_field_class_enumeration_get_mapping_labels_for_value_status
+bt_field_class_signed_enumeration_get_mapping_labels_for_value(
                const bt_field_class *field_class, int64_t value,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count);
@@ -209,4 +206,4 @@ extern void bt_field_class_put_ref(const bt_field_class *field_class);
 }
 #endif
 
-#endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H */
+#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */