Documentation fix: add expected types to packet context accessors
authorJérémie Galarneau <jeremie.galarneau@efficios.com>
Sat, 11 Oct 2014 01:49:38 +0000 (21:49 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Sat, 11 Oct 2014 01:49:38 +0000 (21:49 -0400)
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
include/babeltrace/ctf-ir/stream-class.h

index 5c5918d11094e23beb381281bd85b00989c44a72..4055ea13b4b8d4b82bb41ae8425aaa42b96293c7 100644 (file)
@@ -176,7 +176,7 @@ extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_name(
  *
  * @param stream_class Stream class.
  *
- * Returns the packet context's type, NULL on error.
+ * Returns the packet context's type (a structure), NULL on error.
  */
 extern struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type(
                struct bt_ctf_stream_class *stream_class);
@@ -186,6 +186,7 @@ extern struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type(
  * context type.
  *
  * @param stream_class Stream class.
+ * @param packet_context_type Packet context type (must be a structure).
  *
  * Returns 0 on success, a negative value on error.
  */
This page took 0.024497 seconds and 4 git commands to generate.