1 files changed, 26 insertions, 3 deletions
diff --git a/lib/experiment-reader/experiment-reader.h b/lib/experiment-reader/experiment-reader.h
index 6a0cc85..99c5018 100644
--- a/lib/experiment-reader/experiment-reader.h
+++ b/lib/experiment-reader/experiment-reader.h
@@ -1,3 +1,8 @@
+/**
+ * @file
+ * Header file to include when using the \e ExperimentReader class.
+ */
+
 #ifndef __EXPERIMENT_READER_H
 #define __EXPERIMENT_READER_H
 
@@ -8,6 +13,11 @@ G_BEGIN_DECLS
 
 #define EXPERIMENT_TYPE_READER \
 	(experiment_reader_get_type())
+/**
+ * Cast instance pointer to \e ExperimentReader
+ *
+ * @param obj Object to cast to \e ExperimentReader
+ */
 #define EXPERIMENT_READER(obj) \
 	(G_TYPE_CHECK_INSTANCE_CAST((obj), EXPERIMENT_TYPE_READER, ExperimentReader))
 #define EXPERIMENT_READER_CLASS(klass) \
@@ -19,16 +29,23 @@ G_BEGIN_DECLS
 #define EXPERIMENT_READER_GET_CLASS(obj) \
 	(G_TYPE_INSTANCE_GET_CLASS((obj), EXPERIMENT_TYPE_READER, ExperimentReaderClass))
 
+/** @private */
 typedef struct _ExperimentReaderPrivate ExperimentReaderPrivate;
 
+/**
+ * \e ExperimentReader instance structure
+ */
 typedef struct _ExperimentReader {
-	GObject parent_instance;
+	GObject parent_instance;	/**< Parent instance structure */
 
-	ExperimentReaderPrivate *priv; /** private */
+	ExperimentReaderPrivate *priv;	/**< @private */
 } ExperimentReader;
 
+/**
+ * \e ExperimentReader class structure
+ */
 typedef struct _ExperimentReaderClass {
-	GObjectClass parent_class;
+	GObjectClass parent_class;	/**< Parent class structure */
 } ExperimentReaderClass;
 
 GType experiment_reader_get_type(void);
@@ -36,6 +53,12 @@ GType experiment_reader_get_type(void);
 /*
  * Callbacks
  */
+/**
+ * Type of function to use for \b topic callbacks.
+ *
+ * @param topic_id   Symbolic identifier of experiment \b topic
+ * @param start_time Beginning of first \b contribution in \e topic (milliseconds)
+ */
 typedef void (*ExperimentReaderTopicCallback)(const gchar *topic_id,
 					      gint64 start_time,
 					      gpointer data);