Update include/babeltrace/babeltrace.h

[babeltrace.git] / include / babeltrace / values.h

diff --git a/include/babeltrace/values.h b/include/babeltrace/values.h
index 93622a86e17dea9a91304e1274c33cee5d369bbe..b0544ec23937d46436eed21caeb86f972ab1754b 100644 (file)
--- a/include/babeltrace/values.h
+++ b/include/babeltrace/values.h
@@ -1,5 +1,5 @@
-#ifndef _BABELTRACE_VALUES_H
-#define _BABELTRACE_VALUES_H
+#ifndef BABELTRACE_VALUES_H
+#define BABELTRACE_VALUES_H
 
 /*
  * Babeltrace - Value objects
@@ -40,6 +40,10 @@ extern "C" {
 @ingroup apiref
 @brief Value objects.
 
+@code
+#include <babeltrace/values.h>
+@endcode
+
 This is a set of <strong><em>value objects</em></strong>. With the
 functions documented here, you can create and modify:
 
@@ -177,7 +181,7 @@ enum bt_value_status {
        BT_VALUE_STATUS_CANCELLED =     -3,
 
        /* -22 for compatibility with -EINVAL */
-       /// Invalid arguments.
+       /// Invalid argument.
        BT_VALUE_STATUS_INVAL =         -22,
 
        /// General error.
@@ -839,7 +843,7 @@ extern struct bt_value *bt_value_array_create(void);
 @sa bt_value_array_is_empty(): Checks whether or not a given array
        value object is empty.
 */
-extern int bt_value_array_size(const struct bt_value *array_obj);
+extern int64_t bt_value_array_size(const struct bt_value *array_obj);
 
 /**
 @brief Checks whether or not the array value object \p array_obj
@@ -875,7 +879,7 @@ extern bool bt_value_array_is_empty(const struct bt_value *array_obj);
 @postrefcountsame{array_obj}
 */
 extern struct bt_value *bt_value_array_get(const struct bt_value *array_obj,
-               size_t index);
+               uint64_t index);
 
 /**
 @brief Appends the value object \p element_obj to the array value
@@ -1072,7 +1076,7 @@ extern enum bt_value_status bt_value_array_append_empty_map(
 @postrefcountsame{array_obj}
 */
 extern enum bt_value_status bt_value_array_set(struct bt_value *array_obj,
-               size_t index, struct bt_value *element_obj);
+               uint64_t index, struct bt_value *element_obj);
 
 /** @} */
 
@@ -1107,7 +1111,7 @@ extern struct bt_value *bt_value_map_create(void);
 @sa bt_value_map_is_empty(): Checks whether or not a given map value
        object is empty.
 */
-extern int bt_value_map_size(const struct bt_value *map_obj);
+extern int64_t bt_value_map_size(const struct bt_value *map_obj);
 
 /**
 @brief Checks whether or not the map value object \p map_obj is empty.
@@ -1495,4 +1499,4 @@ extern struct bt_value *bt_value_map_extend(struct bt_value *base_map_obj,
 }
 #endif
 
-#endif /* _BABELTRACE_VALUES_H */
+#endif /* BABELTRACE_VALUES_H */