add details for doxygen

svn path=/trunk/; revision=11077

1 files changed, 27 insertions, 5 deletions

diff --git a/gtk/range_utils.h b/gtk/range_utils.h
index 75a1e2c6da..823217a470 100644
--- a/gtk/range_utils.h
+++ b/gtk/range_utils.h
@@ -1,7 +1,7 @@
 /* range_utils.h
  * Declarations of utilities to with range_utils.c (packet range dialog)
  *
- * $Id: range_utils.h,v 1.1 2004/04/22 21:29:34 ulfl Exp $
+ * $Id: range_utils.h,v 1.2 2004/06/02 22:13:04 ulfl Exp $
  *
  * Ulf Lamping <ulf.lamping@web.de>
  *
@@ -27,20 +27,42 @@
 #ifndef __RANGE_UTILS_H__
 #define __RANGE_UTILS_H__
 
-/* create a new range "widget" */
+/** @file
+ *  Packet range widget used for example in the "Save" and "Print" dialogs.
+ */
+
+/** Create a new range widget.
+ *
+ * @param range the range to set
+#if GTK_MAJOR_VERSION < 2
+ * @param accel_group accelerator group (GTK1 only)
+#endif
+ * @return the new range widget
+ */
 extern GtkWidget *range_new(packet_range_t *range
 #if GTK_MAJOR_VERSION < 2
 , GtkAccelGroup *accel_group
 #endif
 );
 
-/* update all "dynamic" things */
+/* Update all "dynamic" range things.
+ *
+ * @param data range widget
+ */
 extern void range_update_dynamics(gpointer data);
 
-/* set the "Process only marked packets" toggle button as appropriate */
+/** Set the "Process only marked packets" toggle button as appropriate.
+ *
+ * @param data range widget
+ * @param marked_valid TRUE, if marked packets available
+ */
 extern void range_set_marked_sensitive(gpointer data, gboolean marked_valid);
 
-/* set the "displayed" button as appropriate */
+/** Set the "displayed" button as appropriate.
+ *
+ * @param data range widget
+ * @param displayed_valid TRUE, if displayed packets available
+ */
 extern void range_set_displayed_sensitive(gpointer data, gboolean displayed_valid);
 
 #endif