Move and update documentation

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

diff --git a/lttv/lttv/sync/event_matching.h b/lttv/lttv/sync/event_matching.h
index e4c37732975ba542b6a486f4fad4bc4a90e8d0a2..4e8befc35520c85fae46a6f3d5519f1c43879f8f 100644 (file)
--- a/lttv/lttv/sync/event_matching.h
+++ b/lttv/lttv/sync/event_matching.h
@@ -30,14 +30,40 @@ typedef struct
        char* name;
        bool canMatch[TYPE_COUNT];
 
+       /*
+        * This function is called at the beginning of a synchronization run for a set
+        * of traces. Allocate the matching specific data structures.
+        */
        void (*initMatching)(struct _SyncState* const syncState);
+
+       /*
+        * Free the matching specific data structures.
+        */
        void (*destroyMatching)(struct _SyncState* const syncState);
 
+       /*
+        * Try to match one event from a trace with the corresponding event from
+        * another trace. If it is possible, create a new structure and call the
+        * analyse{message,exchange,broadcast} function of the analysis module.
+        */
        void (*matchEvent)(struct _SyncState* const syncState, Event* const
                event);
+
+       /*
+        * Obtain the factors from downstream.
+        */
        AllFactors* (*finalizeMatching)(struct _SyncState* const syncState);
 
+       /*
+     * Print statistics related to matching. Is always called after
+     * finalizeMatching.
+     */
        void (*printMatchingStats)(struct _SyncState* const syncState);
+
+       /*
+        * Write the matching-specific options and graph commands in the gnuplot
+        * script. Is always called after finalizeMatching.
+        */
        GraphFunctions graphFunctions;
 } MatchingModule;