lib: Reset libbabeltrace2 to SONANE 0

[babeltrace.git] / include / babeltrace / lib-logging-internal.h

diff --git a/include/babeltrace/lib-logging-internal.h b/include/babeltrace/lib-logging-internal.h
index 6e04f9a25a91af218a656c8530aa8b391c7e5ef4..ae7fb9e6b31c171079e12414f76705e235269504 100644 (file)
--- a/include/babeltrace/lib-logging-internal.h
+++ b/include/babeltrace/lib-logging-internal.h
@@ -2,7 +2,7 @@
 #define BABELTRACE_LIB_LOGGING_INTERNAL_H
 
 /*
- * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -79,8 +79,8 @@ int bt_lib_log_level;
  * The available format specifiers are:
  *
  *   `F`:
- *       Trace IR field type. The parameter type is `struct
- *       bt_field_type *`.
+ *       Trace IR field class. The parameter type is
+ *      `struct bt_field_class *`.
  *
  *   `f`:
  *       Trace IR field. The parameter type is `struct bt_field *`.
@@ -89,15 +89,15 @@ int bt_lib_log_level;
  *       Field path. The parameter type is `struct bt_field_path *`.
  *
  *   `E`:
- *       Trace IR event class. The parameter type is `struct
- *       bt_event_class *`.
+ *       Trace IR event class. The parameter type is
+ *      `struct bt_event_class *`.
  *
  *   `e`:
  *       Trace IR event. The parameter type is `struct bt_event *`.
  *
  *   `S`:
- *       Trace IR stream class. The parameter type is `struct
- *       bt_stream_class *`.
+ *       Trace IR stream class. The parameter type is
+ *      `struct bt_stream_class *`.
  *
  *   `s`:
  *       Trace IR stream. The parameter type is `struct bt_stream *`.
@@ -105,6 +105,9 @@ int bt_lib_log_level;
  *   `a`:
  *       Packet. The parameter type is `struct bt_packet *`.
  *
+ *   `T`:
+ *       Trace IR trace class. The parameter type is `struct bt_trace_class *`.
+ *
  *   `t`:
  *       Trace IR trace. The parameter type is `struct bt_trace *`.
  *
@@ -112,21 +115,21 @@ int bt_lib_log_level;
  *       Clock class. The parameter type is `struct bt_clock_class *`.
  *
  *   `k`:
- *       Clock value. The parameter type is `struct bt_clock_value *`.
+ *       Clock snapshot. The parameter type is `struct bt_clock_snapshot *`.
  *
  *   `v`:
  *       Value. The parameter type is `struct bt_value *`.
  *
  *   `n`:
- *       Notification. The parameter type is `struct bt_notification *`.
+ *       Message. The parameter type is `struct bt_message *`.
  *
  *   `i`:
- *       Notification iterator. The parameter type is
- *       `struct bt_notification_iterator *`.
+ *       Message iterator. The parameter type is
+ *       `struct bt_message_iterator *`.
  *
  *   `C`:
- *       Component class. The parameter type is `struct
- *       bt_component_class *`.
+ *       Component class. The parameter type is
+ *      `struct bt_component_class *`.
  *
  *   `c`:
  *       Component. The parameter type is `struct bt_component *`.
@@ -141,7 +144,7 @@ int bt_lib_log_level;
  *       Graph. The parameter type is `struct bt_graph *`.
  *
  *   `l`:
- *       Plugin. The parameter type is `struct bt_plugin *`.
+ *       Plugin. The parameter type is `const struct bt_plugin *`.
  *
  *   `o`:
  *       Object pool. The parameter type is `struct bt_object_pool *`.
@@ -158,7 +161,7 @@ int bt_lib_log_level;
  *
  * The string `, ` is printed between individual fields, but not after
  * the last one. Therefore you must put this separator in the format
- * string between two Babeltrace objects, e.g.:
+ * string between two conversion specifiers, e.g.:
  *
  *     BT_LIB_LOGW("Message: count=%u, %!E, %!+K", count, event_class,
  *                 clock_class);
@@ -183,7 +186,7 @@ int bt_lib_log_level;
  * Use one of the BT_LIB_LOGF*() macros above instead of calling this
  * function directly.
  */
-BT_HIDDEN
+
 void bt_lib_log(const char *func, const char *file, unsigned line,
                int lvl, const char *tag, const char *fmt, ...);