From 2e96b4196d7a80039d529e352d6d06be8fa427af Mon Sep 17 00:00:00 2001 From: Robin Haberkorn Date: Mon, 11 Jun 2012 16:29:06 +0200 Subject: documented some previously undocumented libexperiment-reader API functions * minor whitespace changes --- lib/experiment-reader/experiment-reader.h | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) (limited to 'lib/experiment-reader/experiment-reader.h') diff --git a/lib/experiment-reader/experiment-reader.h b/lib/experiment-reader/experiment-reader.h index 8edc58a..13492bf 100644 --- a/lib/experiment-reader/experiment-reader.h +++ b/lib/experiment-reader/experiment-reader.h @@ -86,9 +86,13 @@ typedef void (*ExperimentReaderTopicCallback)(ExperimentReader *reader, gint64 start_time, gpointer data); +/** + * Structure describing a contribution. Every text-fragment identified by + * a distinct \e timepoint is considered a contribution. + */ typedef struct { - gint64 start_time; - gchar text[]; + gint64 start_time; /**< Contribution's start time in milliseconds */ + gchar text[]; /**< Contribution's text content (part of the structure) */ } ExperimentReaderContrib; /* @@ -108,20 +112,20 @@ void experiment_reader_free_contributions( void experiment_reader_foreach_greeting_topic( ExperimentReader *reader, ExperimentReaderTopicCallback callback, - gpointer data); + gpointer userdata); void experiment_reader_foreach_exp_initial_narrative_topic( ExperimentReader *reader, ExperimentReaderTopicCallback callback, - gpointer data); + gpointer userdata); void experiment_reader_foreach_exp_last_minute_phase_topic( ExperimentReader *reader, gint phase, ExperimentReaderTopicCallback callback, - gpointer data); + gpointer userdata); void experiment_reader_foreach_farewell_topic( ExperimentReader *reader, ExperimentReaderTopicCallback callback, - gpointer data); + gpointer userdata); G_END_DECLS -- cgit v1.2.3