lib: add aliases for Babeltrace structure types

[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 e2483b29d9a472980c748526d43360dafcafa974..a936488bb4c8b31db4830f8009d287c56255724e 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,31 +79,37 @@ int bt_lib_log_level;
  * The available format specifiers are:
  *
  *   `F`:
- *       CTF IR field type. The parameter type is `struct bt_field_type *`.
+ *       Trace IR field class. The parameter type is
+ *      `structbt_field_class *`.
  *
  *   `f`:
- *       CTF IR field. The parameter type is `struct bt_field *`.
+ *       Trace IR field. The parameter type is `struct bt_field *`.
  *
  *   `P`:
  *       Field path. The parameter type is `struct bt_field_path *`.
  *
  *   `E`:
- *       CTF IR event class. The parameter type is `struct bt_event_class *`.
+ *       Trace IR event class. The parameter type is
+ *      `struct bt_event_class *`.
  *
  *   `e`:
- *       CTF IR event. The parameter type is `struct bt_event *`.
+ *       Trace IR event. The parameter type is `struct bt_event *`.
  *
  *   `S`:
- *       CTF IR stream class. The parameter type is `struct bt_stream_class *`.
+ *       Trace IR stream class. The parameter type is
+ *      `struct bt_stream_class *`.
  *
  *   `s`:
- *       CTF IR stream. The parameter type is `struct bt_stream *`.
+ *       Trace IR stream. The parameter type is `struct bt_stream *`.
  *
  *   `a`:
  *       Packet. The parameter type is `struct bt_packet *`.
  *
+ *   `T`:
+ *       Trace IR trace class. The parameter type is `struct bt_trace_class *`.
+ *
  *   `t`:
- *       CTF IR trace. The parameter type is `struct bt_trace *`.
+ *       Trace IR trace. The parameter type is `struct bt_trace *`.
  *
  *   `K`:
  *       Clock class. The parameter type is `struct bt_clock_class *`.
@@ -122,7 +128,8 @@ int bt_lib_log_level;
  *       `struct bt_notification_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 *`.
@@ -137,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 *`.