Move and update documentation

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

diff --git a/lttv/lttv/sync/event_processing.h b/lttv/lttv/sync/event_processing.h
index c3815bd70297418c28fd566bf86e9db91ec7c50c..1bc9ade3c1f0ebd8582820b29419c80972528879 100644 (file)
--- a/lttv/lttv/sync/event_processing.h
+++ b/lttv/lttv/sync/event_processing.h
@@ -31,10 +31,33 @@ typedef struct
 {
        char* name;
 
+       /*
+        * This function is called at the beginning of a synchronization run for a
+        * set of traces. Allocate and initialize data structures for
+        * synchronizing a traceset.
+        */
        void (*initProcessing)(struct _SyncState* const syncStateLttv, ...);
+
+       /*
+        * Obtain the factors from downstream.
+        */
        AllFactors* (*finalizeProcessing)(struct _SyncState* const syncState);
+
+       /*
+        * Print statistics related to processing. Is always called after
+        * finalizeProcessing.
+        */
        void (*printProcessingStats)(struct _SyncState* const syncState);
+
+       /*
+        * Deallocate processingData. No more functions may be called after this.
+        */
        void (*destroyProcessing)(struct _SyncState* const syncState);
+
+       /*
+        * Write the processing-specific options and graph commands in the gnuplot
+        * script. Is always called after finalizeProcessing.
+        */
        GraphFunctions graphFunctions;
 } ProcessingModule;