From 68c252160607050b8d68f8adf8a3f200552cea7f Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Fri, 10 Oct 2014 21:49:38 -0400 Subject: [PATCH] Documentation fix: add expected types to packet context accessors MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- include/babeltrace/ctf-ir/stream-class.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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. */ -- 2.34.1