API doc: CTF IR writer -> CTF writer

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h
index 1f73b26795268776eec55f4e579212e08252999c..c63311f45179a102ab9c0996638d1be35a08de5e 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -73,7 +73,7 @@ object becomes its parent.
 If the \link ctfirtraceclass CTF IR trace class\endlink of an event
 object (parent of its \link ctfirstreamclass CTF IR stream class\endlink,
 which is the parent of its event class) was created by a
-\link ctfirwriter CTF IR writer\endlink object, then the only possible
+\link ctfwriter CTF writer\endlink object, then the only possible
 action you can do with this event object is to append it to a
 \link ctfirstream CTF IR stream\endlink with
 bt_ctf_stream_append_event(). Otherwise, you can create an event

diff --git a/include/babeltrace/ctf-ir/stream-class.h b/include/babeltrace/ctf-ir/stream-class.h
index ed82b84824b0b9d899e579da924f1d22b3aeab6e..3d570eaa6c9ea0881d60cb8e97d1b8ffd3d362b7 100644 (file)
--- a/include/babeltrace/ctf-ir/stream-class.h
+++ b/include/babeltrace/ctf-ir/stream-class.h
@@ -47,8 +47,8 @@ extern "C" {
 @endcode
 
 @note
-See \ref ctfirwriterstreamclass which documents additional CTF IR stream
-class functions exclusive to the CTF IR writer mode.
+See \ref ctfwriterstreamclass which documents additional CTF IR stream
+class functions exclusive to the CTF writer mode.
 
 A CTF IR <strong><em>stream class</em></strong> is a template that you
 can use to create concrete \link ctfirstream CTF IR streams\endlink.
@@ -104,7 +104,7 @@ success:
 - bt_ctf_trace_add_stream_class()
 - bt_ctf_event_create()
 - bt_ctf_writer_create_stream()
-  (\link ctfirwriter CTF IR writer\endlink mode only)
+  (\link ctfwriter CTF writer\endlink mode only)
 
 You cannot modify a frozen stream class: it is considered immutable,
 except for:
@@ -116,7 +116,7 @@ except for:
 @sa ctfirstream
 @sa ctfireventclass
 @sa ctfirtraceclass
-@sa ctfirwriterstreamclass
+@sa ctfwriterstreamclass
 
 @file
 @brief CTF IR stream class type and functions.
@@ -613,7 +613,7 @@ extern int bt_ctf_stream_class_visit(struct bt_ctf_stream_class *stream_class,
 
 /** @} */
 
-// TODO: document for writer
+// TODO: document for CTF writer
 extern struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
                struct bt_ctf_stream_class *stream_class);
 

diff --git a/include/babeltrace/ctf-ir/stream.h b/include/babeltrace/ctf-ir/stream.h
index 75e34d48bbd7c2a0c2bf3f5d633951b4e7cab69f..510f17dc2ea5bda13a61338553679b31dac73686 100644 (file)
--- a/include/babeltrace/ctf-ir/stream.h
+++ b/include/babeltrace/ctf-ir/stream.h
@@ -47,8 +47,8 @@ extern "C" {
 @endcode
 
 @note
-See \ref ctfirwriterstream which documents additional CTF IR stream
-functions exclusive to the CTF IR writer mode.
+See \ref ctfwriterstream which documents additional CTF IR stream
+functions exclusive to the CTF writer mode.
 
 A CTF IR <strong><em>stream</em></strong> is an instance of a
 \link ctfirstreamclass CTF IR stream class\endlink.
@@ -57,10 +57,10 @@ You can obtain a CTF IR stream object in two different modes:
 
 - <strong>Normal mode</strong>: use bt_ctf_stream_create() with a stream
   class having a \link ctfirtraceclass CTF IR trace class\endlink parent
-  \em not created by a \link ctfirwriter CTF IR writer\endlink object to
+  \em not created by a \link ctfwriter CTF writer\endlink object to
   create a default stream.
-- <strong>CTF IR writer mode</strong>: use bt_ctf_stream_create() with
-  a stream class having a trace class parent created by a CTF IR writer
+- <strong>CTF writer mode</strong>: use bt_ctf_stream_create() with
+  a stream class having a trace class parent created by a CTF writer
   object, or use bt_ctf_writer_create_stream().
 
 A CTF IR stream object represents a CTF stream, that is, a sequence of
@@ -79,7 +79,7 @@ management of Babeltrace objects.
 
 @sa ctfirstreamclass
 @sa ctfirpacket
-@sa ctfirwriterstream
+@sa ctfwriterstream
 
 @file
 @brief CTF IR stream type and functions.
@@ -93,7 +93,7 @@ management of Babeltrace objects.
 @struct bt_ctf_stream
 @brief A CTF IR stream.
 @sa ctfirstream
-@sa ctfirwriterstream
+@sa ctfwriterstream
 */
 struct bt_ctf_stream;
 struct bt_ctf_event;
@@ -106,9 +106,9 @@ struct bt_ctf_event;
 \link ctfirtraceclass CTF IR trace class\endlink.
 
 If the parent \link ctfirtraceclass trace class\endlink of
-\p stream_class was created by a \link ctfirwriter CTF IR writer\endlink
-object, then the stream object is created in CTF IR writer mode, and
-you can use the functions of \ref ctfirwriterstream on it.
+\p stream_class was created by a \link ctfwriter CTF writer\endlink
+object, then the stream object is created in CTF writer mode, and
+you can use the functions of \ref ctfwriterstream on it.
 Otherwise it is created in normal mode: you should only use the
 functions documented in this module on it.
 

diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h
index ba6b28cdce3cb3f4e31a90b07600c698773adc80..0629ee25de024e2d0bedd77fc5d66c19ecbd8d38 100644 (file)
--- a/include/babeltrace/ctf-ir/trace.h
+++ b/include/babeltrace/ctf-ir/trace.h
@@ -56,8 +56,8 @@ You can obtain a trace class in two different modes:
 
 - <strong>Normal mode</strong>: use bt_ctf_trace_create() to create a
   default, empty trace class.
-- <strong>CTF IR writer mode</strong>: use bt_ctf_writer_get_trace() to
-  get the trace class created by a given CTF IR writer object.
+- <strong>CTF writer mode</strong>: use bt_ctf_writer_get_trace() to
+  get the trace class created by a given CTF writer object.
 
 A trace class has the following properties:
 
@@ -109,7 +109,7 @@ success:
 
 - bt_ctf_trace_add_stream_class()
 - bt_ctf_writer_create_stream()
-  (\link ctfirwriter CTF IR writer\endlink mode only)
+  (\link ctfwriter CTF writer\endlink mode only)
 
 You cannot modify a frozen trace class: it is considered immutable,
 except for: