API doc: add #include line in the detailed description

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-class.h b/include/babeltrace/ctf-ir/event-class.h
index 7478e49e57ecbc28b43578ec6e2e2205156c2466..f446cc2cfd862291e1ea20c9da71f3344f80f22c 100644 (file)
--- a/include/babeltrace/ctf-ir/event-class.h
+++ b/include/babeltrace/ctf-ir/event-class.h
@@ -43,6 +43,10 @@ extern "C" {
 @ingroup ctfir
 @brief CTF IR event class.
 
 @ingroup ctfir
 @brief CTF IR event class.
 

+@code
+#include <babeltrace/ctf-ir/event-class.h>
+@endcode
+

 A CTF IR <strong><em>event class</em></strong> is a template that you
 can use to create concrete \link ctfirevent CTF IR events\endlink.
 
 A CTF IR <strong><em>event class</em></strong> is a template that you
 can use to create concrete \link ctfirevent CTF IR events\endlink.
 

diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h
index 54b284c4014786a313b89b5a877345633505b7ff..6d45e33f27d375848c863e33e1ce2e503dc511fe 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -43,6 +43,10 @@ extern "C" {
 @ingroup ctfir
 @brief CTF IR event.
 
 @ingroup ctfir
 @brief CTF IR event.
 

+@code
+#include <babeltrace/ctf-ir/event.h>
+@endcode
+

 A CTF IR <strong><em>event</em></strong> is a container of event
 fields:
 
 A CTF IR <strong><em>event</em></strong> is a container of event
 fields:
 

diff --git a/include/babeltrace/ctf-ir/packet.h b/include/babeltrace/ctf-ir/packet.h
index 126fa20331885a6a12ad5ad7c88796b7219c3bdd..839895fcf0c5b70bd91ec6340c911b07a12557b2 100644 (file)
--- a/include/babeltrace/ctf-ir/packet.h
+++ b/include/babeltrace/ctf-ir/packet.h
@@ -39,6 +39,10 @@ extern "C" {
 @ingroup ctfir
 @brief CTF IR packet.
 
 @ingroup ctfir
 @brief CTF IR packet.
 

+@code
+#include <babeltrace/ctf-ir/packet.h>
+@endcode
+

 A CTF IR <strong><em>packet</em></strong> is a container of packet
 fields, that is, of the <strong>trace packet header</strong> and
 <strong>stream packet context</strong> fields.
 A CTF IR <strong><em>packet</em></strong> is a container of packet
 fields, that is, of the <strong>trace packet header</strong> and
 <strong>stream packet context</strong> fields.

diff --git a/include/babeltrace/ctf-ir/stream-class.h b/include/babeltrace/ctf-ir/stream-class.h
index 1db7ec5796ebd2f57bcc4dbea663e40cfb225cc2..1959d9569a4643ac4d62c7fb7e7eecb38385e3fb 100644 (file)
--- a/include/babeltrace/ctf-ir/stream-class.h
+++ b/include/babeltrace/ctf-ir/stream-class.h
@@ -42,6 +42,10 @@ extern "C" {
 @ingroup ctfir
 @brief CTF IR stream class.
 
 @ingroup ctfir
 @brief CTF IR stream class.
 

+@code
+#include <babeltrace/ctf-ir/stream-class.h>
+@endcode
+

 @note
 See \ref ctfirwriterstreamclass which documents additional CTF IR stream
 class functions exclusive to the CTF IR writer mode.
 @note
 See \ref ctfirwriterstreamclass which documents additional CTF IR stream
 class functions exclusive to the CTF IR writer mode.

diff --git a/include/babeltrace/ctf-ir/stream.h b/include/babeltrace/ctf-ir/stream.h
index f1191bc6b0bd7081a938bc15ab6031d59f524322..0d6d560603dd34d24fda7863807e362a5bcefa19 100644 (file)
--- a/include/babeltrace/ctf-ir/stream.h
+++ b/include/babeltrace/ctf-ir/stream.h
@@ -42,6 +42,10 @@ extern "C" {
 @ingroup ctfir
 @brief CTF IR stream.
 
 @ingroup ctfir
 @brief CTF IR stream.
 

+@code
+#include <babeltrace/ctf-ir/stream.h>
+@endcode
+

 @note
 See \ref ctfirwriterstream which documents additional CTF IR stream
 functions exclusive to the CTF IR writer mode.
 @note
 See \ref ctfirwriterstream which documents additional CTF IR stream
 functions exclusive to the CTF IR writer mode.

diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h
index 8a9831f59c5f80dc161d02218b5f372e5736c3ae..c7322b8139f75a06a5ca5662317c7620333f8450 100644 (file)
--- a/include/babeltrace/ctf-ir/trace.h
+++ b/include/babeltrace/ctf-ir/trace.h
@@ -45,6 +45,10 @@ extern "C" {
 @ingroup ctfir
 @brief CTF IR trace class.
 
 @ingroup ctfir
 @brief CTF IR trace class.
 

+@code
+#include <babeltrace/ctf-ir/trace.h>
+@endcode
+

 A CTF IR <strong><em>trace class</em></strong> is a descriptor of
 traces.
 
 A CTF IR <strong><em>trace class</em></strong> is a descriptor of
 traces.
 

diff --git a/include/babeltrace/ctf-ir/utils.h b/include/babeltrace/ctf-ir/utils.h
index 83d6db7666a47ea650b3b19638f2f86501d15c89..21db2e72a1b65c36b9061ff8ee3dfedda1ad1425 100644 (file)
--- a/include/babeltrace/ctf-ir/utils.h
+++ b/include/babeltrace/ctf-ir/utils.h
@@ -39,6 +39,10 @@ extern "C" {
 @ingroup ctfir
 @brief CTF IR utilities.
 
 @ingroup ctfir
 @brief CTF IR utilities.
 

+@code
+#include <babeltrace/ctf-ir/utils.h>
+@endcode
+

 @file
 @brief CTF IR utilities functions.
 @sa ctfirutils
 @file
 @brief CTF IR utilities functions.
 @sa ctfirutils

diff --git a/include/babeltrace/ctf-ir/visitor.h b/include/babeltrace/ctf-ir/visitor.h
index 2773006525516d45c0a9e480466da9edc29c1e7b..293d305dcfbd0c9260f49fe407dd5e0b31978f98 100644 (file)
--- a/include/babeltrace/ctf-ir/visitor.h
+++ b/include/babeltrace/ctf-ir/visitor.h
@@ -39,6 +39,10 @@ extern "C" {
 @ingroup ctfir
 @brief CTF IR visitor.
 
 @ingroup ctfir
 @brief CTF IR visitor.
 

+@code
+#include <babeltrace/ctf-ir/visitor.h>
+@endcode
+

 A CTF IR <strong><em>visitor</em></strong> is a function that you
 can use to visit the hierarchy of a
 \link ctfirtraceclass CTF IR trace class\endlink with
 A CTF IR <strong><em>visitor</em></strong> is a function that you
 can use to visit the hierarchy of a
 \link ctfirtraceclass CTF IR trace class\endlink with