Code review

git-svn-id: file:///svnroot/mdictionary/trunk@231 5bde0345-f819-0410-ac75-e5045f9217cc

diff --git a/src/gui/include/ws_gui_callbacks.h b/src/gui/include/ws_gui_callbacks.h
index 32a24ba..8b923bb 100644 (file)
--- a/src/gui/include/ws_gui_callbacks.h
+++ b/src/gui/include/ws_gui_callbacks.h
@@ -51,7 +51,6 @@ extern "C" {
 /* added by Dariusz Wiechecki - HISA */
 void ws_gui_search_home_handler(GError *error, GArray *word, gpointer user_data);
 
-/*do dbusa*/
 /** \brief handle dbus signals
  *
  */
@@ -261,12 +260,24 @@ void ws_gui_set_bookmark_menu_items(GtkMenuItem *menuitem, gpointer user_data);
  */
 void ws_gui_read_active_dictionaries(gpointer user_data);
 
+/** \brief free a GArray and its elements.
+ *
+ */
 void ws_gui_clear_array(GArray *history);
 
+/** \brief escapes a bug in Hildon GtkTreeList
+ *
+ */
 void ws_gui_view_cursor_changed(GtkTreeView *treeview, gpointer user_data);
 
+/** \brief sets toolbar availability
+ *
+ */
 void ws_gui_set_toolbar_avail(gpointer user_data);
 
+/** \brief refreshes search results
+ *
+ */
 void ws_refresh_search_results(gpointer user_data);
 
 #ifdef __cplusplus

diff --git a/src/gui/src/ws_gui_callbacks.c b/src/gui/src/ws_gui_callbacks.c
index de1230a..b96d5b7 100644 (file)
--- a/src/gui/src/ws_gui_callbacks.c
+++ b/src/gui/src/ws_gui_callbacks.c
@@ -2383,6 +2383,11 @@ void ws_gui_read_active_dictionaries(gpointer user_data)
                                        NULL);
 }
 
+/** Deletes all elements from a GArray
+*
+* @param history - a GArray to be acted upon
+* @return
+*/
 void ws_gui_clear_array(GArray *history)
 {
        if(history->len >= 0)
@@ -2391,6 +2396,13 @@ void ws_gui_clear_array(GArray *history)
        }
 }
 
+/** Fixes a bug in hildon GtkTreeView(check if the GtkTreeView widget isn't
+ * unnecessarily cleared and initialized 
+ *
+ * @param treeview - a treeview to act upon
+ * @param user_data - user data set when the function was called
+ * @return
+ */
 void ws_gui_view_cursor_changed(GtkTreeView *treeview, gpointer user_data)
 {
        WSGuiApp* ws_gui_app=(WSGuiApp*)user_data;
@@ -2430,6 +2442,11 @@ void ws_gui_view_cursor_changed(GtkTreeView *treeview, gpointer user_data)
        
 }
 
+/** Sets toolbar availability
+*
+* @param user_data - user data set when the function was called
+* @return
+*/
 void ws_gui_set_toolbar_avail(gpointer user_data) {
        
        WSGuiApp* ws_gui_app=(WSGuiApp*)user_data;
@@ -2457,6 +2474,11 @@ void ws_gui_set_toolbar_avail(gpointer user_data) {
        }
 }
 
+/** refreshes search results
+*
+* @param user_data - user data set when the function was called
+* @return
+*/
 void ws_refresh_search_results(gpointer user_data) {
        
        WSGuiApp* ws_gui_app=(WSGuiApp*)user_data;