[Goodies-commits] r3475 - xfce4-notes-plugin/trunk/panel-plugin

[Mike Massonnet]

Author: mmassonnet
Date: 2007-10-29 13:23:51 +0000 (Mon, 29 Oct 2007)
New Revision: 3475

Modified:
   xfce4-notes-plugin/trunk/panel-plugin/notes.c
Log:
    * panel-plugin/notes.c: Add some comments around a bit


Modified: xfce4-notes-plugin/trunk/panel-plugin/notes.c
===================================================================
--- xfce4-notes-plugin/trunk/panel-plugin/notes.c	2007-10-29 13:23:47 UTC (rev 3474)
+++ xfce4-notes-plugin/trunk/panel-plugin/notes.c	2007-10-29 13:23:51 UTC (rev 3475)
@@ -106,6 +106,11 @@
                                                          GdkEventKey *event);
 
 
+/**
+ * - Iterator to fetch all windows
+ * - Window creation functions
+ * - Load and save the data
+ */
 const gchar *
 notes_window_read_name (NotesPlugin *notes_plugin)
 {
@@ -568,6 +573,9 @@
     notes_window_new (notes_plugin);
 }
 
+/**
+ * Window menu
+ */
 static void
 notes_window_menu_new (NotesWindow *notes_window)
 {
@@ -918,6 +926,9 @@
   gdk_error_trap_pop ();
 }
 
+/**
+ * Window state event
+ */
 static gboolean
 notes_window_state_event (NotesWindow *notes_window,
                           GdkEventWindowState *event)
@@ -947,6 +958,9 @@
   return FALSE;
 }
 
+/**
+ * Show/hide the window
+ */
 void
 notes_window_show (NotesWindow *notes_window)
 {
@@ -1006,6 +1020,11 @@
   return TRUE; /* Stop other handlers from being invoked (incl. ALT+F4) */
 }
 
+/**
+ * Event on title press/release
+ * - Set to fore/background
+ * - Start a move
+ */
 static gboolean
 notes_window_title_press (NotesWindow *notes_window,
                           GdkEventButton *event)
@@ -1060,6 +1079,10 @@
   return FALSE;
 }
 
+/**
+ * Scroll event on title
+ * - Shade/unshade
+ */
 static gboolean
 notes_window_scroll_event (NotesWindow *notes_window,
                            GdkEventScroll *event)
@@ -1122,6 +1145,9 @@
     }
 }
 
+/**
+ * Rename window
+ */
 static void
 notes_window_rename_note_dialog (NotesWindow *notes_window)
 {
@@ -1226,6 +1252,9 @@
   return rc_rename;
 }
 
+/**
+ * Sort function for window names
+ */
 inline void
 notes_window_sort_names (NotesWindow *notes_window)
 {
@@ -1247,6 +1276,9 @@
   return res;
 }
 
+/**
+ * Functions to create/delete a note and return the current note
+ */
 static inline NotesNote *
 notes_window_get_current_note (NotesWindow *notes_window)
 {
@@ -1295,6 +1327,11 @@
 
 
 
+/**
+ * - Iterator to fetch all notes from a window
+ * - Note creation functions
+ * - Load and save the data
+ */
 const gchar *
 notes_note_read_name (NotesWindow *notes_window)
 {
@@ -1517,6 +1554,9 @@
   g_slice_free (NotesNote, notes_note);
 }
 
+/**
+ * Function to set the font
+ */
 static void
 notes_note_set_font (NotesNote *notes_note,
                      const gchar *font)
@@ -1529,6 +1569,9 @@
   pango_font_description_free (font_desc);
 }
 
+/**
+ * Rename the note
+ */
 static void
 notes_note_rename_dialog (NotesNote *notes_note)
 {
@@ -1612,6 +1655,9 @@
   return rc;
 }
 
+/**
+ * Sort fuction for note names
+ */
 static void
 notes_note_sort_names (NotesNote *notes_note)
 {
@@ -1639,6 +1685,9 @@
   return res;
 }
 
+/**
+ * Event on GtkTextBuffer
+ */
 static gboolean
 notes_note_key_pressed (NotesNote *notes_note,
                         GdkEventKey *event)
@@ -1663,8 +1712,6 @@
         default:
           break;
         }
-
-      return FALSE;
     }
   else if (event->state & GDK_MOD1_MASK)
     {
@@ -1689,8 +1736,6 @@
         default:
           break;
         }
-
-      return FALSE;
     }
 
   return FALSE;