add more details for doxygen

svn path=/trunk/; revision=11107

1 files changed, 74 insertions, 18 deletions

diff --git a/gtk/dlg_utils.h b/gtk/dlg_utils.h
index 8516a57346..76f0bf8566 100644
--- a/gtk/dlg_utils.h
+++ b/gtk/dlg_utils.h
@@ -1,7 +1,7 @@
 /* dlg_utils.h
  * Declarations of utilities to use when constructing dialogs
  *
- * $Id: dlg_utils.h,v 1.19 2004/06/01 20:28:04 ulfl Exp $
+ * $Id: dlg_utils.h,v 1.20 2004/06/04 17:16:57 ulfl Exp $
  *
  * Ethereal - Network traffic analyzer
  * By Gerald Combs <gerald@ethereal.com>
@@ -22,29 +22,71 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  */
 
+/** @defgroup dialog_group Dialogs
+ *
+ * Dialogs are specially created windows and are related to their parent windows (usually the main window). 
+ * See: @ref howto_window_page for details.
+ *
+ * @section normal_dialogs Normal dialogs 
+ *
+ * Normal dialogs are created using dlg_window_new().
+ *
+ * - "About" about_ethereal_cb()
+ * - "Capture Options" capture_prep()
+ * - "Capture" capture_info_create()
+ * - "Interface Options" ifopts_edit_cb()
+ * - "Coloring Rules" colorize_dialog_new()
+ * - "Edit Color Filter" edit_color_filter_dialog_new()
+ * - "Compute DCE-RPC SRT statistics" gtk_dcerpcstat_cb()
+ * - "Decode As: Show" decode_show_cb()
+ * - "Decode As" decode_as_cb()
+ * - "Filter Expression" dfilter_expr_dlg_new()
+ * - "Compute Fibre Channel Service Response Time statistics" gtk_fcstat_cb()
+ * - "Filter" (display and capture) filter_dialog_new()
+ * - "Find Packet" find_frame_cb()
+ * - "Follow TCP stream" follow_stream_cb()
+ * - "Go To Packet" goto_frame_cb()
+ * - "Compute LDAP Service Response Time statistics" gtk_ldapstat_cb()
+ * - "Preferences" tools_plugins_cmd_cb()
+ * - "Print" / "Export" open_print_dialog()
+ * - "Progress" create_progress_dlg()
+ * - "Enabled Protocols" proto_cb()
+ * - "Compute ONC-RPC SRT statistics" gtk_rpcstat_cb()
+ * - "RTP Streams" rtpstream_dlg_create()
+ * - "Simple Dialog" display_simple_dialog()
+ * - "Compute SMB SRT statistics" gtk_smbstat_cb()
+ * - "Compute ..." gtk_tap_dfilter_dlg_cb()
+ * - "Tcp Graph" create_drawing_area()
+ * - "Tcp Graph Control" control_panel_create()
+ * - "Help for TCP graphing" callback_create_help()
+ * - "Tcp Graph Magnify" magnify_create()
+ *
+ * @section file_sel_dialogs File selection dialogs 
+ *
+ * File selection dialogs are created using file_selection_new().
+ *
+ * - "Browse" file_selection_browse()
+ * - "Open Capture File" file_open_cmd()
+ * - "Save Capture File As" file_save_as_cmd()
+ * - "Import Color Filters" file_color_import_cmd_cb()
+ * - "Export Color Filters" file_color_export_cmd_cb()
+ * - "Save TCP Follow Stream As" follow_save_as_cmd_cb()
+ * - "Export Selected Packet Bytes" savehex_cb()
+ * - "Save Data As CSV" save_csv_as_cb()
+ * - "Save Payload As ..." on_save_bt_clicked()
+ * - "Save selected stream in rtpdump" rtpstream_on_save()
+ * 
+ */
+
 /** @file
- * Utilities for dialog boxes, depending on the window functions in 
- * ui_util.h. These dialog box windows will be related to Ethereal's main 
- * window. See window_new() and others in ui_util.h for further explanation 
- * of dialogs and windows in Ethereal.
+ * Utilities for dialog boxes. Depending on the window functions in 
+ * ui_util.h, see: @ref howto_window_page for details.
+ * @ingroup dialog_group
  */
 
 #ifndef __DLG_UTILS_H__
 #define __DLG_UTILS_H__
 
-/** Get the latest opened directory.
- *
- * @return the dirname
- */
-char *get_last_open_dir(void);
-
-/** Set the latest opened directory.
- *  Will already be done when using file_selection_new().
- *
- * @param dirname the dirname
- */
-void set_last_open_dir(char *dirname);
-
 
 /** Create a dialog box window that belongs to Ethereal's main window.
  * If you want to create a window, use window_new() instead. 
@@ -101,6 +143,20 @@ extern void file_selection_set_extra_widget(GtkWidget *fs, GtkWidget *extra);
 extern void
 file_selection_browse(GtkWidget *file_bt, GtkWidget *file_te, const char *title, file_selection_action_t action);
 
+/** Get the latest opened directory.
+ *
+ * @return the dirname
+ */
+extern char *get_last_open_dir(void);
+
+/** Set the latest opened directory.
+ *  Will already be done when using file_selection_new().
+ *
+ * @param dirname the dirname
+ */
+extern void set_last_open_dir(char *dirname);
+
+
 /** Create a button row (with variable number of buttons) for a dialog.
  *  The button widgets will be available by OBJECT_GET_DATA(dlg, stock_id) later.
  *