From 6dd2bd0c811d382f28ccb20a74ed56b68ef5eb01 Mon Sep 17 00:00:00 2001
From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Tue, 22 Nov 2016 23:44:45 -0500
Subject: [PATCH] API doc: add #include line in the detailed description
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---
 include/babeltrace/ctf-ir/event-class.h  | 4 ++++
 include/babeltrace/ctf-ir/event.h        | 4 ++++
 include/babeltrace/ctf-ir/packet.h       | 4 ++++
 include/babeltrace/ctf-ir/stream-class.h | 4 ++++
 include/babeltrace/ctf-ir/stream.h       | 4 ++++
 include/babeltrace/ctf-ir/trace.h        | 4 ++++
 include/babeltrace/ctf-ir/utils.h        | 4 ++++
 include/babeltrace/ctf-ir/visitor.h      | 4 ++++
 8 files changed, 32 insertions(+)

diff --git a/include/babeltrace/ctf-ir/event-class.h b/include/babeltrace/ctf-ir/event-class.h
index 7478e49e..f446cc2c 100644
--- 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.
 
+@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.
 
diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h
index 54b284c4..6d45e33f 100644
--- 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.
 
+@code
+#include <babeltrace/ctf-ir/event.h>
+@endcode
+
 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 126fa203..839895fc 100644
--- 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.
 
+@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.
diff --git a/include/babeltrace/ctf-ir/stream-class.h b/include/babeltrace/ctf-ir/stream-class.h
index 1db7ec57..1959d956 100644
--- 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.
 
+@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.
diff --git a/include/babeltrace/ctf-ir/stream.h b/include/babeltrace/ctf-ir/stream.h
index f1191bc6..0d6d5606 100644
--- 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.
 
+@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.
diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h
index 8a9831f5..c7322b81 100644
--- 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.
 
+@code
+#include <babeltrace/ctf-ir/trace.h>
+@endcode
+
 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 83d6db76..21db2e72 100644
--- 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.
 
+@code
+#include <babeltrace/ctf-ir/utils.h>
+@endcode
+
 @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 27730065..293d305d 100644
--- 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.
 
+@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
-- 
2.34.1