From: Jérémie Galarneau Date: Sat, 11 Oct 2014 01:49:38 +0000 (-0400) Subject: Documentation fix: add expected types to packet context accessors X-Git-Tag: v2.0.0-pre1~1489 X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=68c252160607050b8d68f8adf8a3f200552cea7f Documentation fix: add expected types to packet context accessors Signed-off-by: Jérémie Galarneau --- diff --git a/include/babeltrace/ctf-ir/stream-class.h b/include/babeltrace/ctf-ir/stream-class.h index 5c5918d1..4055ea13 100644 --- a/include/babeltrace/ctf-ir/stream-class.h +++ b/include/babeltrace/ctf-ir/stream-class.h @@ -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. */