[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] r29092 - in gnunet-gtk/src: fs include lib setup statistics
|
From: |
gnunet |
|
Subject: |
[GNUnet-SVN] r29092 - in gnunet-gtk/src: fs include lib setup statistics |
|
Date: |
Sat, 7 Sep 2013 18:48:20 +0200 |
Author: grothoff
Date: 2013-09-07 18:48:20 +0200 (Sat, 07 Sep 2013)
New Revision: 29092
Modified:
gnunet-gtk/src/fs/gnunet-fs-gtk_event-handler.c
gnunet-gtk/src/fs/gnunet-fs-gtk_publish-edit-dialog.c
gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.c
gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.h
gnunet-gtk/src/include/gnunet_gtk.h
gnunet-gtk/src/lib/about.c
gnunet-gtk/src/lib/os_installation.c
gnunet-gtk/src/setup/gnunet-setup-gns-edit.c
gnunet-gtk/src/setup/gnunet-setup-gns-edit.h
gnunet-gtk/src/setup/gnunet-setup-gns.c
gnunet-gtk/src/statistics/gnunet-statistics-gtk.c
Log:
-doxygen fixes
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:19:14 UTC
(rev 29091)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_event-handler.c 2013-09-07 16:48:20 UTC
(rev 29092)
@@ -909,7 +909,7 @@
* Download "abort" was selected in the current search context menu.
*
* @param item the 'abort' menu item
- * @parma user_data the 'struct SearchListPopupContext' with the download to
abort.
+ * @param user_data the 'struct SearchListPopupContext' with the download to
abort.
*/
static void
abort_download_ctx_menu (GtkMenuItem *item, gpointer user_data)
@@ -929,7 +929,7 @@
* Copy current URI to clipboard was selected in the current context menu.
*
* @param item the 'copy-to-clipboard' menu item
- * @parma user_data the 'struct SearchListPopupContext' of the menu
+ * @param user_data the 'struct SearchListPopupContext' of the menu
*/
static void
copy_search_uri_to_clipboard_ctx_menu (GtkMenuItem *item, gpointer user_data)
@@ -2357,8 +2357,8 @@
/**
- * Sets downloaded name on an item referenced by @rr
- * in a tree store @ts to @filename.
+ * Sets downloaded name on an item referenced by @a rr
+ * in a tree store @a ts to @a filename.
* Used by SaveAs dialog to communicate back new filename
* (unless SaveAs dialog initiates the download by itself).
* Arguments can be taken from DownloadEntry.
@@ -3535,7 +3535,7 @@
* Publish "abort" was selected in the current publish context menu.
*
* @param item the 'abort' menu item
- * @parma user_data the 'struct PublishListPopupContext' with the operation to
abort.
+ * @param user_data the 'struct PublishListPopupContext' with the operation to
abort.
*/
static void
abort_publish_ctx_menu (GtkMenuItem *item, gpointer user_data)
@@ -3552,7 +3552,7 @@
* Copy current URI to clipboard was selected in the current context menu.
*
* @param item the 'copy-to-clipboard' menu item
- * @parma user_data the 'struct DownloadListPopupContext' of the menu
+ * @param user_data the 'struct DownloadListPopupContext' of the menu
*/
static void
copy_publish_uri_to_clipboard_ctx_menu (GtkMenuItem *item, gpointer user_data)
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:19:14 UTC (rev 29091)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_publish-edit-dialog.c 2013-09-07
16:48:20 UTC (rev 29092)
@@ -419,7 +419,7 @@
* 'GNUNET_GTK_edit_publication_metadata_tree_view_type_renderer_edited_cb'.
*
* @param combo combo box that was dropped down
- * @param path which item was changed in the tree view
+ * @param path_string which item was changed in the tree view
* @param new_iter item that is now selected in the drop-down combo box
* @param user_data the 'struct EditPublicationDialogContext'
*/
Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.c
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.c 2013-09-07 16:19:14 UTC (rev
29091)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.c 2013-09-07 16:48:20 UTC (rev
29092)
@@ -430,11 +430,12 @@
* An unindex operation resumed. Setup the
* internal context for Gtk.
*
- * @param fs unindex context with the FS library
+ * @param uc unindex context with the FS library
* @param filename name of file being unindexed
* @param filesize size of the file
* @param completed how many bytes were done so far
* @param emsg NULL if everything is fine, otherwise error message
+ * @return entry for the resumed operation
*/
struct UnindexEntry *
GNUNET_FS_GTK_unindex_handle_resume_ (struct GNUNET_FS_UnindexContext *uc,
@@ -460,7 +461,7 @@
/**
- * FS notified us that our undex operation was stopped.
+ * FS notified us that our unindex operation was stopped.
*
* @param ue operation that stopped
*/
@@ -496,7 +497,7 @@
/**
- * FS notified us that our undex operation had an error.
+ * FS notified us that our unindex operation had an error.
*
* @param ue operation that had an error
* @param emsg error message
@@ -527,7 +528,7 @@
/**
- * FS notified us that our undex operation made progress
+ * FS notified us that our unindex operation made progress
*
* @param ue operation that made progress
* @param completed number of bytes completed now
@@ -557,7 +558,7 @@
/**
- * FS notified us that our undex operation completed
+ * FS notified us that our unindex operation completed
*
* @param ue operation that completed
*/
Modified: gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.h
===================================================================
--- gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.h 2013-09-07 16:19:14 UTC (rev
29091)
+++ gnunet-gtk/src/fs/gnunet-fs-gtk_unindex.h 2013-09-07 16:48:20 UTC (rev
29092)
@@ -40,11 +40,12 @@
* An unindex operation resumed. Setup the
* internal context for Gtk.
*
- * @param fs unindex context with the FS library
+ * @param uc unindex context with the FS library
* @param filename name of file being unindexed
* @param filesize size of the file
* @param completed how many bytes were done so far
* @param emsg NULL if everything is fine, otherwise error message
+ * @return entry for the resumed operation
*/
struct UnindexEntry *
GNUNET_FS_GTK_unindex_handle_resume_ (struct GNUNET_FS_UnindexContext *uc,
@@ -55,7 +56,7 @@
/**
- * FS notified us that our undex operation was stopped.
+ * FS notified us that our unindex operation was stopped.
*
* @param ue operation that stopped
*/
@@ -64,7 +65,7 @@
/**
- * FS notified us that our undex operation had an error.
+ * FS notified us that our unindex operation had an error.
*
* @param ue operation that
* @param emsg error message
@@ -75,7 +76,7 @@
/**
- * FS notified us that our undex operation made progress
+ * FS notified us that our unindex operation made progress
*
* @param ue operation that made progress
* @param completed number of bytes completed now
@@ -86,7 +87,7 @@
/**
- * FS notified us that our undex operation completed
+ * FS notified us that our unindex operation completed
*
* @param ue operation that completed
*/
Modified: gnunet-gtk/src/include/gnunet_gtk.h
===================================================================
--- gnunet-gtk/src/include/gnunet_gtk.h 2013-09-07 16:19:14 UTC (rev 29091)
+++ gnunet-gtk/src/include/gnunet_gtk.h 2013-09-07 16:48:20 UTC (rev 29092)
@@ -1,6 +1,6 @@
/*
This file is part of GNUnet.
- (C) 2011 Christian Grothoff (and other contributing authors)
+ (C) 2011, 2013 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
@@ -82,8 +82,10 @@
/**
* @brief get the path to a specific GNUnet installation directory or,
- * with GNUNET_IPK_SELF_PREFIX, the current running apps installation directory
+ * with #GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
directory
* @author Milan
+ *
+ * @param dirkind which directory should be returned
* @return a pointer to the dir path (to be freed by the caller)
*/
char *
@@ -107,7 +109,10 @@
/**
- * This displays an about dialog.
+ * This displays an about dialog. The dialog must be called
+ * "about_window" with "about_credits_notebook" and
+ * "about_license_scroller" and "about_license_contents" being the
+ * respective subdialogs.
*
* @param dialogfile name of the glade file containing the dialog
*/
@@ -195,7 +200,7 @@
* @param options allowed command line options
* @param main_window_file glade file for the main window
* @param main_task first task to run, closure will be set to the 'struct
GNUNET_GTK_MainLoop'
- * @return GNUNET_OK on success, GNUNET_SYSERR on error (i.e. bad command-line
options, etc)
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error (i.e. bad
command-line options, etc)
*/
int
GNUNET_GTK_main_loop_start (const char *binary_name, const char *binary_help,
@@ -308,7 +313,7 @@
* Obtain the animated pixbuf from an animation context. Note
* that the pixbuf will only properly work within GtkTreeViews
* where the column with the image has been registered using
- * GNUNET_GTK_animation_tree_view_register.
+ * #GNUNET_GTK_animation_tree_view_register.
*
* @param ac animation context to query
* @return pixbuf of the AC, NULL on error loading the pixbuf
Modified: gnunet-gtk/src/lib/about.c
===================================================================
--- gnunet-gtk/src/lib/about.c 2013-09-07 16:19:14 UTC (rev 29091)
+++ gnunet-gtk/src/lib/about.c 2013-09-07 16:48:20 UTC (rev 29092)
@@ -117,10 +117,12 @@
/**
- * This displays an about dialog.
+ * This displays an about dialog. The dialog must be called
+ * "about_window" with "about_credits_notebook" and
+ * "about_license_scroller" and "about_license_contents" being the
+ * respective subdialogs.
*
* @param dialogfile name of the glade file containing the dialog
- * @param dialogname name of the about dialog in the file
*/
void
GNUNET_GTK_display_about (const char *dialogfile)
Modified: gnunet-gtk/src/lib/os_installation.c
===================================================================
--- gnunet-gtk/src/lib/os_installation.c 2013-09-07 16:19:14 UTC (rev
29091)
+++ gnunet-gtk/src/lib/os_installation.c 2013-09-07 16:48:20 UTC (rev
29092)
@@ -304,7 +304,6 @@
* Return the actual path to a file found in the current
* PATH environment variable.
*
- * @param binary the name of the file to find
* @return path to binary, NULL if not found
*/
static char *
Modified: gnunet-gtk/src/setup/gnunet-setup-gns-edit.c
===================================================================
--- gnunet-gtk/src/setup/gnunet-setup-gns-edit.c 2013-09-07 16:19:14 UTC
(rev 29091)
+++ gnunet-gtk/src/setup/gnunet-setup-gns-edit.c 2013-09-07 16:48:20 UTC
(rev 29092)
@@ -465,6 +465,7 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
@@ -497,7 +498,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -513,7 +513,6 @@
/**
* Run an GNS Edit dialog for an 'A' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -575,6 +574,7 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
@@ -607,7 +607,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -623,7 +622,6 @@
/**
* Run an GNS Edit dialog for an 'AAAA' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -684,6 +682,7 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
@@ -716,7 +715,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -732,7 +730,6 @@
/**
* Run an GNS Edit dialog for an 'CNAME' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -793,6 +790,7 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
@@ -825,7 +823,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -841,7 +838,6 @@
/**
* Run an GNS Edit dialog for an 'LEHO' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -902,6 +898,7 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
@@ -943,7 +940,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -959,7 +955,6 @@
/**
* Run an GNS Edit dialog for an 'MX' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -1036,12 +1031,13 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
GNS_edit_ns_dialog_response_cb (GtkDialog *dialog,
- gint response_id,
- gpointer user_data)
+ gint response_id,
+ gpointer user_data)
{
struct EditDialogContext *edc = user_data;
GtkEntry *entry;
@@ -1068,12 +1064,11 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
GNS_edit_dialog_ns_entry_changed_cb (GtkEditable *entry,
- gpointer user_data)
+ gpointer user_data)
{
struct EditDialogContext *edc = user_data;
@@ -1084,7 +1079,6 @@
/**
* Run an GNS Edit dialog for an 'NS' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -1149,6 +1143,7 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
@@ -1181,7 +1176,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -1197,7 +1191,6 @@
/**
* Run an GNS Edit dialog for an 'PKEY' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -1258,12 +1251,13 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
GNS_edit_ptr_dialog_response_cb (GtkDialog *dialog,
- gint response_id,
- gpointer user_data)
+ gint response_id,
+ gpointer user_data)
{
struct EditDialogContext *edc = user_data;
GtkEntry *entry;
@@ -1290,7 +1284,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -1306,7 +1299,6 @@
/**
* Run an GNS Edit dialog for an 'PTR' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -1382,6 +1374,7 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
@@ -1442,7 +1435,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -1460,7 +1452,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -1476,7 +1467,6 @@
/**
* Run an GNS Edit dialog for an 'SOA' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -1583,6 +1573,7 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
@@ -1620,7 +1611,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -1636,7 +1626,6 @@
/**
* Run an GNS Edit dialog for an 'SRV' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -1688,12 +1677,13 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
GNS_edit_txt_dialog_response_cb (GtkDialog *dialog,
- gint response_id,
- gpointer user_data)
+ gint response_id,
+ gpointer user_data)
{
struct EditDialogContext *edc = user_data;
GtkEntry *entry;
@@ -1720,7 +1710,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -1736,7 +1725,6 @@
/**
* Run an GNS Edit dialog for an 'TXT' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -1799,12 +1787,13 @@
* continuation.
*
* @param dialog editing dialog
+ * @param response_id action that caused the dialog to be closed
* @param user_data the 'struct EditDialogContext'
*/
void
GNS_edit_vpn_dialog_response_cb (GtkDialog *dialog,
- gint response_id,
- gpointer user_data)
+ gint response_id,
+ gpointer user_data)
{
struct EditDialogContext *edc = user_data;
GtkEntry *entry;
@@ -1845,7 +1834,6 @@
* button depending on the validity of the value.
*
* @param entry editing widget
- * @param preedit new value
* @param user_data the 'struct EditDialogContext' of the dialog
*/
void
@@ -1861,7 +1849,6 @@
/**
* Run an GNS Edit dialog for an 'VPN' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
Modified: gnunet-gtk/src/setup/gnunet-setup-gns-edit.h
===================================================================
--- gnunet-gtk/src/setup/gnunet-setup-gns-edit.h 2013-09-07 16:19:14 UTC
(rev 29091)
+++ gnunet-gtk/src/setup/gnunet-setup-gns-edit.h 2013-09-07 16:48:20 UTC
(rev 29092)
@@ -155,7 +155,6 @@
/**
* Run an GNS Edit dialog for an 'AAAA' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -165,7 +164,6 @@
/**
* Run an GNS Edit dialog for an 'CNAME' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -175,7 +173,6 @@
/**
* Run an GNS Edit dialog for an 'LEHO' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -185,7 +182,6 @@
/**
* Run an GNS Edit dialog for an 'MX' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -195,7 +191,6 @@
/**
* Run an GNS Edit dialog for an 'NS' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -205,7 +200,6 @@
/**
* Run an GNS Edit dialog for an 'PKEY' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -215,7 +209,6 @@
/**
* Run an GNS Edit dialog for an 'PTR' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -225,7 +218,6 @@
/**
* Run an GNS Edit dialog for an 'SOA' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -235,7 +227,6 @@
/**
* Run an GNS Edit dialog for an 'SRV' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -245,7 +236,6 @@
/**
* Run an GNS Edit dialog for an 'TXT' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
@@ -255,7 +245,6 @@
/**
* Run an GNS Edit dialog for an 'VPN' Record.
*
- * @param cont continuation to call when done
* @param edc editing context to use
*/
void
Modified: gnunet-gtk/src/setup/gnunet-setup-gns.c
===================================================================
--- gnunet-gtk/src/setup/gnunet-setup-gns.c 2013-09-07 16:19:14 UTC (rev
29091)
+++ gnunet-gtk/src/setup/gnunet-setup-gns.c 2013-09-07 16:48:20 UTC (rev
29092)
@@ -1222,8 +1222,8 @@
* The user has selected a new record type. Update the
* model and then start the 'edit' dialog.
*
- * @param renderer updated renderer
- * @param path the path identifying the edited cell
+ * @param text renderer updated renderer
+ * @param path_string the path identifying the edited cell
* @param new_text updated text
* @param user_data unused
*/
@@ -1720,10 +1720,10 @@
* Function called for each record in the current zone. Update the
* widgets accordingly.
*
- * @param NULL
+ * @param cls NULL
* @param zone_key private key of the zone
* @param name name that is being mapped (at most 255 characters long)
- * @param rd_count number of entries in 'rd' array
+ * @param rd_count number of entries in @a rd array
* @param rd array of records with data to store
*/
static void
Modified: gnunet-gtk/src/statistics/gnunet-statistics-gtk.c
===================================================================
--- gnunet-gtk/src/statistics/gnunet-statistics-gtk.c 2013-09-07 16:19:14 UTC
(rev 29091)
+++ gnunet-gtk/src/statistics/gnunet-statistics-gtk.c 2013-09-07 16:48:20 UTC
(rev 29092)
@@ -171,7 +171,7 @@
/**
* Actually draw a plot based on collected data.
*
- * @param widget size and style information for the plot
+ * @param box_name name of the widget to update
* @param info what to draw
*/
static void
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] r29092 - in gnunet-gtk/src: fs include lib setup statistics,
gnunet <=