aboutsummaryrefslogtreecommitdiff
path: root/lib/experiment-reader/experiment-reader.h
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2012-05-13 18:15:33 +0200
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2012-05-13 18:15:33 +0200
commit1cf0a01006b1d117135bd22fcca7d6b4377d131c (patch)
treed54ce8cf9ee97993ab595c5ddfd268f34c9d8a6c /lib/experiment-reader/experiment-reader.h
parent9791320b76f7aa056c7a777de5bddb9bc0eca7df (diff)
downloadexperiment-player-1cf0a01006b1d117135bd22fcca7d6b4377d131c.tar.gz
updated experiment-reader documentation and topic-callback
Diffstat (limited to 'lib/experiment-reader/experiment-reader.h')
-rw-r--r--lib/experiment-reader/experiment-reader.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/lib/experiment-reader/experiment-reader.h b/lib/experiment-reader/experiment-reader.h
index 9eab878..7747d95 100644
--- a/lib/experiment-reader/experiment-reader.h
+++ b/lib/experiment-reader/experiment-reader.h
@@ -17,6 +17,7 @@ G_BEGIN_DECLS
* Cast instance pointer to \e ExperimentReader
*
* @param obj Object to cast to \e ExperimentReader
+ * @return \e obj casted to \e ExperimentReader
*/
#define EXPERIMENT_READER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj), EXPERIMENT_TYPE_READER, ExperimentReader))
@@ -55,12 +56,15 @@ GType experiment_reader_get_type(void);
* Callbacks
*/
/**
- * Type of function to use for \b topic callbacks.
+ * Type of function to use for \e topic callbacks.
*
+ * @param reader \e ExperimentReader the information refers to
* @param topic_id Symbolic identifier of experiment \b topic
* @param start_time Beginning of first \b contribution in \e topic (milliseconds)
+ * @param data Callback user data
*/
-typedef void (*ExperimentReaderTopicCallback)(const gchar *topic_id,
+typedef void (*ExperimentReaderTopicCallback)(ExperimentReader *reader,
+ const gchar *topic_id,
gint64 start_time,
gpointer data);