From d389bc8dc65698c827ee8df7311f4034dcdfad26 Mon Sep 17 00:00:00 2001
From: pmf <pmf@04897980-b3bd-0310-b5e0-8ef037075253>
Date: Fri, 30 May 2008 15:15:32 +0000
Subject: [PATCH] add documentation and fix typos

git-svn-id: http://ltt.polymtl.ca/svn@2936 04897980-b3bd-0310-b5e0-8ef037075253
---
 .../poly/lttv/modules/gui/lttvwindow/lttvwindow/callbacks.c | 4 ++++
 .../modules/gui/lttvwindow/lttvwindow/lttvwindowtraces.c    | 6 ++++--
 .../poly/lttv/modules/gui/resourceview/eventhooks.c         | 5 +++++
 3 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/callbacks.c b/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/callbacks.c
index 09e66563..817044b8 100644
--- a/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/callbacks.c
+++ b/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/callbacks.c
@@ -892,6 +892,10 @@ void open_traceset(GtkWidget * widget, gpointer user_data)
 }
 
 /* lttvwindow_process_pending_requests
+ *
+ * Process requests for parts of the trace from viewers.
+ *
+ * These requests are made by lttvwindow_events_request().
  * 
  * This internal function gets called by g_idle, taking care of the pending
  * requests. It is responsible for concatenation of time intervals and position
diff --git a/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/lttvwindowtraces.c b/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/lttvwindowtraces.c
index c5bd1935..caa84cee 100644
--- a/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/lttvwindowtraces.c
+++ b/ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/lttvwindowtraces.c
@@ -1003,6 +1003,8 @@ static gint find_window_widget(MainWindow *a, GtkWidget *b)
 
 
 /* lttvwindowtraces_process_pending_requests
+ *
+ * Process the pending background computation requests
  * 
  * This internal function gets called by g_idle, taking care of the pending
  * requests.
@@ -1615,7 +1617,7 @@ void lttvwindowtraces_register_computation_hooks(LttvAttributeName module_name,
 
 
 /**
- * It removes all the requests than can be currently processed by the
+ * It removes all the requests that can be currently processed by the
  * background computation algorithm for all the traces (list_in and list_out).
  *
  * Leaves the flag to in_progress or none.. depending if current or queue
@@ -1709,7 +1711,7 @@ void lttvwindowtraces_unregister_requests(LttvAttributeName module_name)
 /**
  * Unregister the background computation hooks for a specific module.
  *
- * It also removes all the requests than can be currently processed by the
+ * It also removes all the requests that can be currently processed by the
  * background computation algorithm for all the traces (list_in and list_out).
  *
  * @param module_name A GQuark : the name of the module which computes the
diff --git a/ltt/branches/poly/lttv/modules/gui/resourceview/eventhooks.c b/ltt/branches/poly/lttv/modules/gui/resourceview/eventhooks.c
index d94d18eb..6c74bdbb 100644
--- a/ltt/branches/poly/lttv/modules/gui/resourceview/eventhooks.c
+++ b/ltt/branches/poly/lttv/modules/gui/resourceview/eventhooks.c
@@ -2021,6 +2021,11 @@ int before_chunk(void *hook_data, void *call_data)
   return 0;
 }
 
+/* before_request
+ *
+ * This gets executed just before an events request is executed
+ */
+
 int before_request(void *hook_data, void *call_data)
 {
   EventsRequest *events_request = (EventsRequest*)hook_data;
-- 
2.34.1