changeset 36103:236d31040749

Revise signal callback function doxygen comments. Explain the function instead of the signal.
author ib
date Tue, 30 Apr 2013 13:10:27 +0000
parents 0fade14b5df1
children 4e3c56728d1e
files gui/dialog/fileselect.c gui/dialog/url.c
diffstat 2 files changed, 8 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/gui/dialog/fileselect.c	Tue Apr 30 12:48:41 2013 +0000
+++ b/gui/dialog/fileselect.c	Tue Apr 30 13:10:27 2013 +0000
@@ -527,7 +527,8 @@
 }
 
 /**
- * @brief The "key-release-event" signal user function.
+ * @brief Handle the escape, return and backspace key depending on the
+ *        @a widget it has been pressed on.
  *
  * @param widget object which received the signal
  * @param event GdkEventKey which triggered the signal
--- a/gui/dialog/url.c	Tue Apr 30 12:48:41 2013 +0000
+++ b/gui/dialog/url.c	Tue Apr 30 13:10:27 2013 +0000
@@ -39,10 +39,15 @@
 static GList *urlEntries;
 
 /**
- * @brief The "clicked" signal user function.
+ * @brief Add the entered URL to the URL list and stream it,
+ *        if the button clicked is the OK button
+ *
+ * @note If the scheme is missing, http is assumed (and added).
  *
  * @param button object which received the signal
  * @param user_data user data set when the signal handler was connected
+ *
+ * @note The button is determined by checking @a user_data.
  */
 static void button_clicked(GtkButton *button, gpointer user_data)
 {