Move and update documentation

[lttv.git] / lttv / lttv / sync / event_analysis.h

diff --git a/lttv/lttv/sync/event_analysis.h b/lttv/lttv/sync/event_analysis.h
index 146b9b62a025c85c94ba382f1b4f6dbcdb6b3ecf..da26cf35715cdb5ab759c749a0aeb217f83c34bd 100644 (file)
--- a/lttv/lttv/sync/event_analysis.h
+++ b/lttv/lttv/sync/event_analysis.h
@@ -31,18 +31,51 @@ typedef struct
 {
        char* name;
 
+       /*
+        * This function is called at the beginning of a synchronization run for a set
+        * of traces. Allocate analysis specific data structures.
+        */
        void (*initAnalysis)(struct _SyncState* const syncState);
+
+       /*
+        * Free the analysis specific data structures.
+        */
        void (*destroyAnalysis)(struct _SyncState* const syncState);
 
+       /*
+        * Perform analysis on an event pair.
+        */
        void (*analyzeMessage)(struct _SyncState* const syncState, Message* const
                message);
+
+       /*
+        * Perform analysis on multiple messages.
+        */
        void (*analyzeExchange)(struct _SyncState* const syncState, Exchange* const
                exchange);
+
+       /*
+        * Perform analysis on muliple events.
+        */
        void (*analyzeBroadcast)(struct _SyncState* const syncState, Broadcast* const
                broadcast);
+
+       /*
+        * Finalize the factor calculations. Return synchronization factors
+        * between trace pairs.
+        */
        AllFactors* (*finalizeAnalysis)(struct _SyncState* const syncState);
 
+       /*
+        * Print statistics related to analysis. Is always called after
+        * finalizeAnalysis.
+        */
        void (*printAnalysisStats)(struct _SyncState* const syncState);
+
+       /*
+        * Write the analysis-specific options and graph commands in the gnuplot
+        * script. Is always called after finalizeAnalysis.
+        */
        GraphFunctions graphFunctions;
 } AnalysisModule;