[GNUnet-SVN] r29093 - gnunet-gtk/src/fs

[gnunet]

Author: grothoff
Date: 2013-09-07 19:44:21 +0200 (Sat, 07 Sep 2013)
New Revision: 29093

Modified:
   gnunet-gtk/src/fs/gnunet-fs-gtk.c
   gnunet-gtk/src/fs/gnunet-fs-gtk_about.c
   gnunet-gtk/src/fs/gnunet-fs-gtk_anonymity-widgets.c
   gnunet-gtk/src/fs/gnunet-fs-gtk_common.c
   gnunet-gtk/src/fs/gnunet-fs-gtk_common.h
   gnunet-gtk/src/fs/gnunet-fs-gtk_event-handler.c
   gnunet-gtk/src/fs/gnunet-fs-gtk_main-window-meta-data-context-menu.c
   gnunet-gtk/src/fs/gnunet-fs-gtk_main-window-view-toggles.c
   gnunet-gtk/src/fs/gnunet-fs-gtk_open-directory.c
   gnunet-gtk/src/fs/gnunet-fs-gtk_publish-dialog.c
   gnunet-gtk/src/fs/gnunet-fs-gtk_publish-edit-dialog.c
   gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.c
Log:
-more doxygen fixes

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk.c   2013-09-07 16:48:20 UTC (rev 29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk.c   2013-09-07 17:44:21 UTC (rev 29093)
@@ -208,6 +208,8 @@
  * and saves these into user's config file.
  *
  * @param main_window main window widget
+ * @param event the event that we are handling
+ * @param user_data main window context
  */
 gboolean
 GNUNET_GTK_main_window_configure_event_cb (GtkWidget *main_window,
@@ -302,6 +304,7 @@
  * Callback invoked if the application is supposed to exit.
  *
  * @param object origin of the quit event, unused
+ * @param event the delete event
  * @param user_data global builder instance, unused
  */
 void

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_about.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_about.c     2013-09-07 16:48:20 UTC (rev 
29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_about.c     2013-09-07 17:44:21 UTC (rev 
29093)
@@ -31,7 +31,7 @@
 /**
  * This displays an about window
  *
- * @param widget widget creating the event, unused
+ * @param dummy widget creating the event, unused
  * @param data global builder, unused
  */
 void

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_anonymity-widgets.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_anonymity-widgets.c 2013-09-07 16:48:20 UTC 
(rev 29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_anonymity-widgets.c 2013-09-07 17:44:21 UTC 
(rev 29093)
@@ -28,12 +28,13 @@
 #include "gnunet-fs-gtk_anonymity-widgets.h"
 #include <gdk/gdk.h>
 
+
 /**
  * Spin button is changed, update its color.  NOTE: This function will 
eventually
  * become obsolete as we migrate to the drop-down style of anonymity-level 
selection.
  *
  * @param w the spin button that changed
- * @param builder's closure, unused
+ * @param data the builder's closure, unused
  */
 void
 GNUNET_GTK_anonymity_spin_button_value_changed_cb (GtkWidget * w, gpointer 
data)

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_common.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_common.c    2013-09-07 16:48:20 UTC (rev 
29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_common.c    2013-09-07 17:44:21 UTC (rev 
29093)
@@ -35,11 +35,11 @@
  * (returns NULL for everything else).
  * Verifies UTF-8 strings.
  *
- * @param format format of the @data
+ * @param format format of the @a data
  * @param data data to convert
- * @param data_len length of the data buffer (in bytes)
+ * @param data_len length of the @a data buffer (in bytes)
  * @return NULL if can't be converted, allocated string otherwise,
- *         freeable with GNUNET_free* ().
+ *         freeable with #GNUNET_free.
  */
 char *
 GNUNET_FS_GTK_dubious_meta_to_utf8 (enum EXTRACTOR_MetaFormat format,
@@ -82,7 +82,7 @@
  *
  * @param cls closure (the GtkListStore)
  * @param plugin_name name of the plugin that produced this value;
- *        special values can be used (i.e. '<zlib>' for zlib being
+ *        special values can be used (i.e. '\<zlib\>' for zlib being
  *        used in the main libextractor library and yielding
  *        meta data).
  * @param type libextractor-type describing the meta data
@@ -90,7 +90,7 @@
  * @param data_mime_type mime-type of data (not of the original file);
  *        can be NULL (if mime-type is not known)
  * @param data actual meta-data found
- * @param data_len number of bytes in data
+ * @param data_len number of bytes in @a data
  * @return 0 to continue (always)
  */
 int

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_common.h
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_common.h    2013-09-07 16:48:20 UTC (rev 
29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_common.h    2013-09-07 17:44:21 UTC (rev 
29093)
@@ -60,7 +60,7 @@
  * time (on midnight, January 1st of that year).
  *
  * @param spin button with the year
- * @param time converted from the spin button
+ * @return time converted from the spin button
  */
 struct GNUNET_TIME_Absolute
 GNUNET_FS_GTK_get_expiration_time (GtkSpinButton * spin);
@@ -86,7 +86,7 @@
  *
  * @param cls closure (the GtkListStore)
  * @param plugin_name name of the plugin that produced this value;
- *        special values can be used (i.e. '<zlib>' for zlib being
+ *        special values can be used (i.e. '\<zlib\>' for zlib being
  *        used in the main libextractor library and yielding
  *        meta data).
  * @param type libextractor-type describing the meta data
@@ -94,7 +94,7 @@
  * @param data_mime_type mime-type of data (not of the original file);
  *        can be NULL (if mime-type is not known)
  * @param data actual meta-data found
- * @param data_len number of bytes in data
+ * @param data_len number of bytes in @a data
  * @return 0 to continue (always)
  */
 int

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_event-handler.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_event-handler.c     2013-09-07 16:48:20 UTC 
(rev 29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_event-handler.c     2013-09-07 17:44:21 UTC 
(rev 29093)
@@ -1106,7 +1106,9 @@
  *
  * @param tm tree model underlying the tree view where the event happened
  * @param tab tab where the event happened
- * @param event_button the event
+ * @param init_button which button triggered the popup, or 0 for none
+ * @param event_time at what time was the popup triggered
+ * @param iter location in the tree model selected at the time
  * @return FALSE if no menu could be popped up,
  *         TRUE if there is now a pop-up menu
  */
@@ -2750,7 +2752,7 @@
   
   /**
    * Do we need to check if the given entry already exists to
-   * avoid adding it twice?  Set to YES if 'add_directory_entry'
+   * avoid adding it twice?  Set to #GNUNET_YES if #add_directory_entry
    * is called upon directory completion (so we might see all
    * entries again) and to NO if this is the initial download
    * and we're calling during a 'PROGRESS' event.
@@ -2774,14 +2776,14 @@
  * @param cls closure, our 'struct AddDirectoryEntryContext*'
  * @param filename name of the file in the directory
  * @param uri URI of the file, NULL for the directory itself
- * @param metadata metadata for the file; metadata for
+ * @param meta metadata for the file; metadata for
  *        the directory if everything else is NULL/zero
  * @param length length of the available data for the file
  *           (of type size_t since data must certainly fit
  *            into memory; if files are larger than size_t
  *            permits, then they will certainly not be
  *            embedded with the directory itself).
- * @param data data available for the file (length bytes)
+ * @param data data available for the file (@a length bytes)
  */
 static void
 add_directory_entry (void *cls, const char *filename,
@@ -2847,7 +2849,7 @@
  * @param completed number of bytes we have completed
  * @param block_data current block we've downloaded
  * @param offset offset of block_data in the overall file
- * @param block_size number of bytes in block_data
+ * @param block_size number of bytes in @a block_data
  * @param depth depth of the block in the ECRS tree
  */
 static void
@@ -3583,7 +3585,9 @@
  *
  * @param tm tree model underlying the tree view where the event happened
  * @param tab tab where the event happened
- * @param event_button the event
+ * @param init_button number of the button that triggered the popup
+ * @param event_time GTK time when the event was generated
+ * @param iter selected element in @a tm for the popup
  * @return FALSE if no menu could be popped up,
  *         TRUE if there is now a pop-up menu
  */

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_main-window-meta-data-context-menu.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_main-window-meta-data-context-menu.c        
2013-09-07 16:48:20 UTC (rev 29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_main-window-meta-data-context-menu.c        
2013-09-07 17:44:21 UTC (rev 29093)
@@ -152,6 +152,7 @@
  * If it was a right click, pop up the context menu.
  *
  * @param widget the tree view widget
+ * @param event the button press event
  * @param user_data the gtk builder of the main window
  */
 gboolean

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_main-window-view-toggles.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_main-window-view-toggles.c  2013-09-07 
16:48:20 UTC (rev 29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_main-window-view-toggles.c  2013-09-07 
17:44:21 UTC (rev 29093)
@@ -35,7 +35,8 @@
  * @param toggle_menu name of menu entry
  */
 static void
-toggle_view (const char *toggled_widget, const char *toggle_menu)
+toggle_view (const char *toggled_widget, 
+            const char *toggle_menu)
 {
   GtkCheckMenuItem *mi;
   GtkWidget *widget;
@@ -53,10 +54,11 @@
  * Preview view is toggled.
  *
  * @param dummy widget triggering the event
- * @param gpointer main window builder (unused)
+ * @param data main window builder (unused)
  */
 void
-GNUNET_GTK_main_menu_view_preview_toggled_cb (GtkWidget * dummy, gpointer data)
+GNUNET_GTK_main_menu_view_preview_toggled_cb (GtkWidget * dummy, 
+                                             gpointer data)
 {
   toggle_view ("GNUNET_GTK_main_window_preview_image",
                "GNUNET_GTK_main_menu_view_preview");
@@ -67,23 +69,26 @@
  * Metadata view is toggled.
  *
  * @param dummy widget triggering the event
- * @param gpointer main window builder (unused)
+ * @param data main window builder (unused)
  */
 void
-GNUNET_GTK_main_menu_view_metadata_toggled_cb (GtkWidget * dummy, gpointer 
data)
+GNUNET_GTK_main_menu_view_metadata_toggled_cb (GtkWidget * dummy, 
+                                              gpointer data)
 {
   toggle_view ("GNUNET_GTK_main_window_metadata_treeview",
                "GNUNET_GTK_main_menu_view_metadata");
 }
 
+
 /**
  * Preview view is toggled.
  *
  * @param dummy widget triggering the event
- * @param gpointer main window builder (unused)
+ * @param data main window builder (unused)
  */
 void
-GNUNET_GTK_main_menu_view_search_toggled_cb (GtkWidget * dummy, gpointer data)
+GNUNET_GTK_main_menu_view_search_toggled_cb (GtkWidget * dummy, 
+                                            gpointer data)
 {
   toggle_view ("main_window_search_hbox",
                "GNUNET_GTK_main_menu_search_preview");

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_open-directory.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_open-directory.c    2013-09-07 16:48:20 UTC 
(rev 29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_open-directory.c    2013-09-07 17:44:21 UTC 
(rev 29093)
@@ -56,14 +56,14 @@
  * @param cls closure, our 'struct AddChildContext*'
  * @param filename name of the file in the directory
  * @param uri URI of the file
- * @param metadata metadata for the file; metadata for
+ * @param meta metadata for the file; metadata for
  *        the directory if everything else is NULL/zero
  * @param length length of the available data for the file
  *           (of type size_t since data must certainly fit
  *            into memory; if files are larger than size_t
  *            permits, then they will certainly not be
  *            embedded with the directory itself).
- * @param data data available for the file (length bytes)
+ * @param data data available for the file (@a length bytes)
  */
 static void
 add_child (void *cls, const char *filename, const struct GNUNET_FS_Uri *uri,
@@ -140,7 +140,7 @@
  * file and then display a new tab with its contents.
  *
  * @param dummy the menu entry
- * @param user_data the main dialog builder, unused
+ * @param data the main dialog builder, unused
  */
 void
 GNUNET_GTK_main_menu_file_open_gnunet_directory_activate_cb (GtkWidget * dummy,

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_publish-dialog.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_publish-dialog.c    2013-09-07 16:48:20 UTC 
(rev 29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_publish-dialog.c    2013-09-07 17:44:21 UTC 
(rev 29093)
@@ -1288,7 +1288,7 @@
  *
  * @param widget the widget emitting the event
  * @param event the event
- * @param user_data progress dialog context of our window
+ * @param cls progress dialog context of our window
  * @return TRUE to refuse to close
  */
 gboolean
@@ -2336,7 +2336,7 @@
  * allowed and if so, close it.
  *
  * @param widget the widget that generated the close event
- * @param even the close event
+ * @param event the close event
  * @param user_data master publishing dialog context of our window
  * @return TRUE to refuse to close (stops other handlers from being invoked)
  *         FALSE to allow closing the window

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_publish-edit-dialog.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_publish-edit-dialog.c       2013-09-07 
16:48:20 UTC (rev 29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_publish-edit-dialog.c       2013-09-07 
17:44:21 UTC (rev 29093)
@@ -553,7 +553,7 @@
  * The user has pushed the 'del' button for metadata.
  * If there is a metadata selected, remove it from the list store.
  *
- * @param widget the button
+ * @param button the delete button
  * @param user_data the 'struct EditPublicationDialogContext'
  */
 void
@@ -667,7 +667,7 @@
  * The user has pushed the 'del' button for the keyword.
  * If there is a keyword selected, remove it from the list store.
  *
- * @param widget the button
+ * @param button the button
  * @param user_data the 'struct EditPublicationDialogContext'
  */
 void
@@ -697,7 +697,7 @@
  * The user has pushed the 'add' button for the keyword (or pressed RETURN).
  * If there is a keyword in the line, add it to the list store.
  *
- * @param widget the entry line, or NULL (if we are called from 'RETURN')
+ * @param button the add button, or NULL (if we are called from 'RETURN')
  * @param user_data the 'struct EditPublicationDialogContext'
  */
 void
@@ -802,7 +802,7 @@
  *        field and the liststore to check the current value
  *        against in 'meta_liststore'.
  * @param plugin_name name of the plugin that produced this value;
- *        special values can be used (i.e. '<zlib>' for zlib being
+ *        special values can be used (i.e. '\<zlib\>' for zlib being
  *        used in the main libextractor library and yielding
  *        meta data).
  * @param type libextractor-type describing the meta data

Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.c   2013-09-07 16:48:20 UTC (rev 
29092)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.c   2013-09-07 17:44:21 UTC (rev 
29093)
@@ -379,7 +379,7 @@
  * User selected "List indexed files..." in menu.  Display dialog.
  *
  * @param dummy the menu entry
- * @param user_data the main dialog builder, unused
+ * @param data the main dialog builder, unused
  */
 void
 GNUNET_GTK_main_menu_unindex_activate_cb (GtkWidget * dummy,