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 4c89aca90ba0ec8ae7cb8b99549538f2cab5c3aa..da26cf35715cdb5ab759c749a0aeb217f83c34bd 100644 (file)
--- a/lttv/lttv/sync/event_analysis.h
+++ b/lttv/lttv/sync/event_analysis.h
@@ -1,19 +1,18 @@
 /* This file is part of the Linux Trace Toolkit viewer
- * Copyright (C) 2009 Benjamin Poirier <benjamin.poirier@polymtl.ca>
+ * Copyright (C) 2009, 2010 Benjamin Poirier <benjamin.poirier@polymtl.ca>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License Version 2 as
- * published by the Free Software Foundation;
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 2.1 of the License, or (at
+ * your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
- * MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef EVENT_ANALYSIS_H
@@ -32,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);
-       GArray* (*finalizeAnalysis)(struct _SyncState* const syncState);
 
+       /*
+        * 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;