osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

add more details for doxygen 

svn path=/trunk/; revision=11110
This commit is contained in:
Ulf Lamping 2004-06-04 20:05:31 +00:00
parent c35250e2df
commit 80afd260f5
23 changed files with 78 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
gtk/about_dlg.h
View File

@ -1,7 +1,7 @@
/* about_dlg.h
* Declarations of routines for the "About" dialog
*
* $Id: about_dlg.h,v 1.2 2004/06/01 20:28:04 ulfl Exp $
* $Id: about_dlg.h,v 1.3 2004/06/04 20:05:30 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
@ -27,6 +27,7 @@
/** @file
* "About" dialog box.
* @ingroup dialog_group
*/
/** User requested the "About" dialog box by menu or toolbar.

3
gtk/capture_dlg.h
View File

@ -1,7 +1,7 @@
/* capture_dlg.h
* Definitions for packet capture windows
*
* $Id: capture_dlg.h,v 1.5 2004/06/01 17:33:35 ulfl Exp $
* $Id: capture_dlg.h,v 1.6 2004/06/04 20:05:30 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
@ -28,6 +28,7 @@
/** @file
* "Capture Options" dialog box.
* @ingroup dialog_group
*/
/** User requested the "Capture Options" dialog box by menu or toolbar.

3
gtk/capture_prefs.h
View File

@ -1,7 +1,7 @@
/* capture_prefs.h
* Definitions for capture preferences window
*
* $Id: capture_prefs.h,v 1.4 2004/06/02 18:44:10 ulfl Exp $
* $Id: capture_prefs.h,v 1.5 2004/06/04 20:05:30 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
@ -27,6 +27,7 @@
/** @file
* "Capture" preferences page.
* @ingroup prefs_group
*/
/** Build a capture preferences page.

3
gtk/color_dlg.h
View File

@ -1,7 +1,7 @@
/* color_dlg.h
* Definitions for dialog boxes for color filters
*
* $Id: color_dlg.h,v 1.5 2004/06/01 20:28:04 ulfl Exp $
* $Id: color_dlg.h,v 1.6 2004/06/04 20:05:30 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
@ -28,6 +28,7 @@
/** @file
* "Colorize Display" dialog box.
* @ingroup dialog_group
*/
/** User requested the "Colorize Display" dialog box by menu or toolbar.

5
gtk/column_prefs.h
View File

@ -1,7 +1,7 @@
/* column_prefs.h
* Definitions for column preferences window
*
* $Id: column_prefs.h,v 1.6 2004/06/02 18:44:10 ulfl Exp $
* $Id: column_prefs.h,v 1.7 2004/06/04 20:05:30 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
@ -27,7 +27,8 @@
#define __COLUMN_PREFS_H__
/** @file
* "Column" preferences page.
* "User Interface: Columns" preferences page.
* @ingroup prefs_group
*/
/** Build a column preferences page.

3
gtk/decode_as_dlg.h
View File

@ -1,6 +1,6 @@
/* decode_as_dlg.h
*
* $Id: decode_as_dlg.h,v 1.5 2004/06/01 20:28:04 ulfl Exp $
* $Id: decode_as_dlg.h,v 1.6 2004/06/04 20:05:30 ulfl Exp $
*
* Routines to modify dissector tables on the fly.
*
@ -28,6 +28,7 @@
/** @file
* "Decode As" / "User Specified Decodes" dialog box.
* @ingroup dialog_group
*/
/** User requested the "Decode As" dialog box by menu or toolbar.

3
gtk/dfilter_expr_dlg.h
View File

@ -1,7 +1,7 @@
/* dfilter_expr_dlg.h
* Definitions for dialog boxes for display filter expression construction
*
* $Id: dfilter_expr_dlg.h,v 1.3 2004/06/01 20:28:04 ulfl Exp $
* $Id: dfilter_expr_dlg.h,v 1.4 2004/06/04 20:05:30 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
@ -28,6 +28,7 @@
/** @file
* "Add Expression" dialog box.
* @ingroup dialog_group
*/
/** User requested the "Add Expression" dialog box by menu or toolbar.

2
gtk/doxygen.cfg
View File

@ -21,7 +21,7 @@ OUTPUT_DIRECTORY =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = .
INPUT = . ../progress_dlg.h ../simple_dialog.h
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

3
gtk/file_dlg.h
View File

@ -1,7 +1,7 @@
/* file_dlg.h
* Definitions for dialog boxes for handling files
*
* $Id: file_dlg.h,v 1.11 2004/06/01 17:33:36 ulfl Exp $
* $Id: file_dlg.h,v 1.12 2004/06/04 20:05:30 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
@ -27,6 +27,7 @@
/** @file
* "Open" / "Close" / "Save" / "Save As" / etc dialog boxes.
* @ingroup dialog_group
*/
/** the action to take, after save has been done */

3
gtk/filter_prefs.h
View File

@ -3,7 +3,7 @@
* (This used to be a notebook page under "Preferences", hence the
* "prefs" in the file name.)
*
* $Id: filter_prefs.h,v 1.19 2004/06/01 17:33:36 ulfl Exp $
* $Id: filter_prefs.h,v 1.20 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
@ -32,6 +32,7 @@
* (This used to be a notebook page under "Preferences", hence the
* "prefs" in the file name.)
* @todo rename this and the corresponding .c file to filter_dlg to reflect current implementation
* @ingroup dialog_group
*/
/**

3
gtk/find_dlg.h
View File

@ -1,7 +1,7 @@
/* find_dlg.h
* Definitions for "find frame" window
*
* $Id: find_dlg.h,v 1.7 2004/06/01 21:56:03 ulfl Exp $
* $Id: find_dlg.h,v 1.8 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
@ -28,6 +28,7 @@
/** @file
* "Find" dialog box and related functions.
* @ingroup dialog_group
*/
/** User requested the "Find" dialog box by menu or toolbar.

3
gtk/follow_dlg.h
View File

@ -1,6 +1,6 @@
/* follow_dlg.c
*
* $Id: follow_dlg.h,v 1.5 2004/06/01 21:56:04 ulfl Exp $
* $Id: follow_dlg.h,v 1.6 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
@ -27,6 +27,7 @@
/** @file
* "Follow TCP Stream" dialog box.
* @ingroup dialog_group
*/
/** User requested the "Follow TCP Stream" dialog box by menu or toolbar.

3
gtk/goto_dlg.h
View File

@ -1,7 +1,7 @@
/* goto_dlg.h
* Definitions for "go to frame" window
*
* $Id: goto_dlg.h,v 1.3 2004/06/01 17:33:36 ulfl Exp $
* $Id: goto_dlg.h,v 1.4 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
@ -28,6 +28,7 @@
/** @file
* "Go To" dialog box and similar functions.
* @ingroup dialog_group
*/
/** User requested the "Go To" dialog box by menu or toolbar.

12
gtk/gtkglobals.h
View File

@ -1,7 +1,7 @@
/* gtkglobals.h
* GTK-related Global defines, etc.
*
* $Id: gtkglobals.h,v 1.27 2004/06/04 17:16:57 ulfl Exp $
* $Id: gtkglobals.h,v 1.28 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
@ -33,20 +33,10 @@
*
* See Modules for a list of submodules.
*
* Additional info pages:
*
* - @ref howto_window_page
*
*/
/** @defgroup helpers_group General purpose helpers
*
* There are some general purpose helper files.
*/
/** @file
* GTK global definitions. For example a pointer to the main application window.
* @ingroup helpers_group
*/
/** application window */

3
gtk/gui_prefs.h
View File

@ -1,7 +1,7 @@
/* gui_prefs.h
* Definitions for GUI preferences window
*
* $Id: gui_prefs.h,v 1.7 2004/06/02 18:44:10 ulfl Exp $
* $Id: gui_prefs.h,v 1.8 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
@ -28,6 +28,7 @@
/** @file
* "User Interface" and "User Interface: Font" preferences pages.
* @ingroup prefs_group
*/
/** Build a User interface preferences page.

3
gtk/help_dlg.h
View File

@ -1,6 +1,6 @@
/* help_dlg.h
*
* $Id: help_dlg.h,v 1.7 2004/06/01 17:33:36 ulfl Exp $
* $Id: help_dlg.h,v 1.8 2004/06/04 20:05:31 ulfl Exp $
*
* Laurent Deniel <laurent.deniel@free.fr>
*
@ -29,6 +29,7 @@
/** @file
* "Help" dialog box.
* @ingroup dialog_group
*/
/** User requested the "Help" dialog box by menu or toolbar.

3
gtk/layout_prefs.h
View File

@ -1,7 +1,7 @@
/* layout_prefs.h
* Definitions for layout preferences window
*
* $Id: layout_prefs.h,v 1.5 2004/06/02 20:14:50 ulfl Exp $
* $Id: layout_prefs.h,v 1.6 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
@ -27,6 +27,7 @@
/** @file
* "User Interface: Layout" preferences page.
* @ingroup prefs_group
*/
/** Build a User interface layout preferences page.

3
gtk/nameres_prefs.h
View File

@ -1,7 +1,7 @@
/* nameres_prefs.h
* Definitions for name resolution preferences window
*
* $Id: nameres_prefs.h,v 1.4 2004/06/02 20:14:51 ulfl Exp $
* $Id: nameres_prefs.h,v 1.5 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
@ -27,6 +27,7 @@
/** @file
* "Name resolution" preferences page.
* @ingroup prefs_group
*/
/** Build a Name resolution preferences page.

36
gtk/prefs_dlg.h
View File

@ -1,7 +1,7 @@
/* prefs_dlg.h
* Definitions for preference handling routines
*
* $Id: prefs_dlg.h,v 1.11 2004/06/02 18:44:10 ulfl Exp $
* $Id: prefs_dlg.h,v 1.12 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
@ -25,8 +25,42 @@
#ifndef __PREFS_DLG_H__
#define __PREFS_DLG_H__
/** @defgroup prefs_group Preferences
*
* All GUI related preferences things. Please note, that some GUI related things
* are saved in the recent file, which is processed in recent.h.
*
* The Preference dialog has the following page submodules:
@dot
digraph prefs_pages {
node [shape=record, fontname=Helvetica, fontsize=10];
dialog [ label="Preferences dialog" URL="\ref prefs_dlg.h"];
ui [ label="User Interface" URL="\ref gui_prefs.h"];
layout [ label="UI: Layout" URL="\ref layout_prefs.h"];
columns [ label="UI: Columns" URL="\ref column_prefs.h"];
font [ label="UI: Font" URL="\ref gui_prefs.h"];
colors [ label="UI: Colors" URL="\ref stream_prefs.h"];
capture [ label="Capture" URL="\ref capture_prefs.h"];
print [ label="Printing" URL="\ref print_prefs.h"];
nameres [ label="Name resolution" URL="\ref nameres_prefs.h"];
protocols [ label="Protocols" URL="\ref prefs_dlg.h"];
dialog -> ui [ arrowhead="open", style="solid" ];
dialog -> layout [ arrowhead="open", style="solid" ];
dialog -> columns [ arrowhead="open", style="solid" ];
dialog -> font [ arrowhead="open", style="solid" ];
dialog -> colors [ arrowhead="open", style="solid" ];
dialog -> capture [ arrowhead="open", style="solid" ];
dialog -> print [ arrowhead="open", style="solid" ];
dialog -> nameres [ arrowhead="open", style="solid" ];
dialog -> protocols [ arrowhead="open", style="solid" ];
}
@enddot
*/
/** @file
* "Preferences" and "Protocol properties" dialog boxes.
* @ingroup dialog_group
* @ingroup prefs_group
*/
/** Show the preferences dialog.

3
gtk/print_prefs.h
View File

@ -1,7 +1,7 @@
/* print_prefs.h
* Definitions for print preferences window
*
* $Id: print_prefs.h,v 1.8 2004/06/02 20:14:51 ulfl Exp $
* $Id: print_prefs.h,v 1.9 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
@ -28,6 +28,7 @@
/** @file
* "Print" preferences page.
* @ingroup prefs_group
*/
/** Build a Print preferences page.

3
gtk/proto_dlg.h
View File

@ -1,6 +1,6 @@
/* proto_dlg.h
*
* $Id: proto_dlg.h,v 1.4 2004/06/02 20:14:51 ulfl Exp $
* $Id: proto_dlg.h,v 1.5 2004/06/04 20:05:31 ulfl Exp $
*
* Laurent Deniel <laurent.deniel@free.fr>
*
@ -29,6 +29,7 @@
/** @file
* "Enabled Protocols" dialog box.
* @ingroup dialog_group
*/
/** Show the enabled protocols dialog.

3
gtk/rtp_stream.h
View File

@ -1,7 +1,7 @@
/* rtp_stream.h
* RTP streams summary addition for ethereal
*
* $Id: rtp_stream.h,v 1.6 2004/06/02 22:13:04 ulfl Exp $
* $Id: rtp_stream.h,v 1.7 2004/06/04 20:05:31 ulfl Exp $
*
* Copyright 2003, Alcatel Business Systems
* By Lars Ruoff <lars.ruoff@gmx.net>
@ -33,6 +33,7 @@
/** @file
* ???
* @ingroup dialog_group
* @todo what's this?
*/

3
gtk/stream_prefs.h
View File

@ -1,7 +1,7 @@
/* stream_prefs.h
* Definitions for stream preferences window
*
* $Id: stream_prefs.h,v 1.6 2004/06/02 20:14:51 ulfl Exp $
* $Id: stream_prefs.h,v 1.7 2004/06/04 20:05:31 ulfl Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
@ -29,6 +29,7 @@
/** @file
* "User Interface: Colors" preferences page.
* @todo rename functions and files from stream to colors
* @ingroup prefs_group
*/
/** Build a Colors preferences page.