forked from osmocom/wireshark
Fix a number of doxygen directives.
svn path=/trunk/; revision=33929
This commit is contained in:
parent
113fac8b77
commit
d936d457c3
|
@ -41,7 +41,7 @@ extern GtkWidget *splash_new(const char *message);
|
|||
*
|
||||
* @param action the initialisation action being performed
|
||||
* @param message additional information
|
||||
* @param client_data the window handle from splash_new()
|
||||
* @param call_data the window handle from splash_new()
|
||||
*/
|
||||
extern void splash_update(register_action_e action, const char *message, void *call_data);
|
||||
|
||||
|
|
|
@ -30,7 +30,7 @@
|
|||
* Normal dialogs are created using dlg_window_new().
|
||||
*
|
||||
* - "About" about_wireshark_cb()
|
||||
* - "Capture Options" capture_prep()
|
||||
* - "Capture Options" capture_prep_cb()
|
||||
* - "Capture" capture_info_ui_create()
|
||||
* - "Interface Options" ifopts_edit_cb()
|
||||
* - "Coloring Rules" colorize_dialog_new()
|
||||
|
|
|
@ -67,7 +67,7 @@ void init_error_table(error_equiv_table *err, guint num_procs, GtkWidget *vbox);
|
|||
/** Init an err table row data structure.
|
||||
*
|
||||
* @param err the err table
|
||||
* @param expert data
|
||||
* @param expert_data data
|
||||
*/
|
||||
void init_error_table_row(error_equiv_table *err, const expert_info_t *expert_data);
|
||||
|
||||
|
|
|
@ -57,6 +57,7 @@ void win32_merge_file (HWND h_wnd);
|
|||
/** Open the "Export" dialog box.
|
||||
*
|
||||
* @param h_wnd HWND of the parent window.
|
||||
* @param export_type The export type.
|
||||
*/
|
||||
void win32_export_file (HWND h_wnd, export_type_e export_type);
|
||||
|
||||
|
@ -84,7 +85,7 @@ void win32_import_color_file(HWND h_wnd, gpointer color_filters);
|
|||
* accordingly.
|
||||
*
|
||||
* @param dlg_hwnd HWND of the dialog in question.
|
||||
* @args Pointer to a print args struct.
|
||||
* @param args Pointer to a print args struct.
|
||||
*/
|
||||
/* XXX - This should be moved to win32-print.c, maybe? */
|
||||
void print_update_dynamic(HWND dlg_hwnd, print_args_t *args);
|
||||
|
|
|
@ -39,7 +39,7 @@
|
|||
*
|
||||
* @param filter_te text-editing filter widget
|
||||
* @param event
|
||||
* @aram user_data pointer to user_data (unused)
|
||||
* @param user_data pointer to user_data (unused)
|
||||
*/
|
||||
extern gboolean filter_string_te_key_pressed_cb(GtkWidget *filter_te, GdkEventKey *event, gpointer user_data _U_);
|
||||
|
||||
|
|
|
@ -107,7 +107,7 @@ void colorize_filter_te_as_valid(GtkWidget *widget);
|
|||
/** Colorize a filter text entry depending on "validity".
|
||||
*
|
||||
* @param widget the text entry to colorize
|
||||
* @param Callback User Data pointer (unused)
|
||||
* @param user_data Callback User Data pointer (unused)
|
||||
*/
|
||||
void filter_te_syntax_check_cb(GtkWidget *widget, gpointer user_data _U_);
|
||||
|
||||
|
|
|
@ -72,8 +72,29 @@ extern void register_stat_menu_item(
|
|||
/**
|
||||
* Same as register_stat_menu_item() but with optional stock item.
|
||||
*
|
||||
* @param name the menu label
|
||||
*
|
||||
* @param group the menu group this stat should be registered to
|
||||
*
|
||||
* @param stock_id the stock_id (icon) to show, or NULL
|
||||
*
|
||||
* @param callback gets called when the menu item is selected; it should do
|
||||
* the work of creating the stat window.
|
||||
*
|
||||
* @param selected_packet_enabled gets called by set_menus_for_selected_packet();
|
||||
* it's passed a pointer to the "frame_data" structure for the current frame,
|
||||
* if any, and to the "epan_dissect_t" structure for that frame, if any, and
|
||||
* should return TRUE if the stat will work now (which might depend on whether
|
||||
* a frame is selected and, if one is, on the frame) and FALSE if not.
|
||||
*
|
||||
* @param selected_tree_row_enabled gets called by
|
||||
* set_menus_for_selected_tree_row(); it's passed a pointer to the
|
||||
* "field_info" structure for the currently selected field, if any,
|
||||
* and should return TRUE if the stat will work now (which might depend on
|
||||
* whether a tree row is selected and, if one is, on the tree row) and
|
||||
* FALSE if not.
|
||||
*
|
||||
* @param callback_data data for callback function
|
||||
*/
|
||||
extern void register_stat_menu_item_stock(
|
||||
const char *name,
|
||||
|
|
|
@ -513,7 +513,7 @@ gint ws_combo_box_get_active(GtkComboBox *combo_box);
|
|||
/**
|
||||
* ws_combo_box_set_active:
|
||||
* @param combo_box A #GtkComboBox constructed using ws_combo_box_new_text_and_pointer()
|
||||
* @param Index of the entry which is to be set as active (ie: selected).
|
||||
* @param idx Index of the entry which is to be set as active (ie: selected).
|
||||
* Index refers to the immediate children of the tree.
|
||||
*/
|
||||
void ws_combo_box_set_active(GtkComboBox *combo_box, gint idx);
|
||||
|
|
|
@ -113,7 +113,7 @@ void topic_cb(GtkWidget *widget, topic_action_e topic);
|
|||
/** Open a specific topic called from a menu item.
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param dummy (unused)
|
||||
* @param event A GdkEventButton *event
|
||||
* @param user_data the topic to display
|
||||
* @return TRUE
|
||||
*/
|
||||
|
|
10
gtk/main.h
10
gtk/main.h
|
@ -138,7 +138,7 @@ typedef enum {
|
|||
|
||||
/** User highlighted item in details window and then right clicked and selected the copy option
|
||||
*
|
||||
* @param widget parent widget
|
||||
* @param w parent widget
|
||||
* @param data parent widget
|
||||
* @param action the function to use
|
||||
*/
|
||||
|
@ -146,16 +146,16 @@ extern void copy_selected_plist_cb(GtkWidget *w _U_, gpointer data, COPY_SELECTE
|
|||
|
||||
/** Set or remove a time reference on this frame
|
||||
*
|
||||
* @param TRUE = set time ref, FALSE=unset time ref
|
||||
* @param pointer to frame
|
||||
* @param row number
|
||||
* @param set TRUE = set time ref, FALSE=unset time ref
|
||||
* @param frame pointer to frame
|
||||
* @param row row number
|
||||
*/
|
||||
extern void set_frame_reftime(gboolean set, frame_data *frame, gint row);
|
||||
|
||||
/** User requested the colorize function
|
||||
* by menu or context menu of protocol tree.
|
||||
*
|
||||
* @param widget parent widget
|
||||
* @param w parent widget
|
||||
* @param data parent widget
|
||||
* @param filt_nr 1-10: use filter for color 1-10
|
||||
* 0: open new colorization rule dialog
|
||||
|
|
|
@ -98,21 +98,21 @@ extern void packet_list_update_marked_frames(void);
|
|||
|
||||
/** Ignore the currently selected packet.
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param w parent widget (unused)
|
||||
* @param data unused
|
||||
*/
|
||||
extern void packet_list_ignore_frame_cb(GtkWidget *w _U_, gpointer data _U_);
|
||||
|
||||
/** Ignore all packets in the list.
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param w parent widget (unused)
|
||||
* @param data unused
|
||||
*/
|
||||
extern void packet_list_ignore_all_frames_cb(GtkWidget *w _U_, gpointer data _U_);
|
||||
|
||||
/** Un-ignore all packets in the list.
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param w parent widget (unused)
|
||||
* @param data unused
|
||||
*/
|
||||
extern void packet_list_unignore_all_frames_cb(GtkWidget *w _U_, gpointer data _U_);
|
||||
|
|
|
@ -142,6 +142,8 @@ typedef enum {
|
|||
*
|
||||
* @param w unused
|
||||
* @param data unused
|
||||
* @param data_type copy_data_type
|
||||
*
|
||||
*/
|
||||
extern void copy_hex_cb(GtkWidget * w, gpointer data, copy_data_type data_type);
|
||||
|
||||
|
|
|
@ -164,7 +164,7 @@ extern GtkWidget *create_preference_entry(GtkWidget *main_tb, int table_row,
|
|||
/** Create a static text for a preferences page.
|
||||
*
|
||||
* @param main_tb the table to put this entry into
|
||||
* @param table_row row in the table
|
||||
* @param table_position row in the table
|
||||
* @param label_text the label text
|
||||
* @param tooltip_text the tooltip for this text (not needed at all...)
|
||||
* @return the new static text label
|
||||
|
@ -176,10 +176,11 @@ create_preference_static_text(GtkWidget *main_tb, int table_position,
|
|||
/** Create a UAT button for a preferences page.
|
||||
*
|
||||
* @param main_tb the table to put this entry into
|
||||
* @param table_row row in the table
|
||||
* @param table_position row in the table
|
||||
* @param label_text the label text
|
||||
* @param tooltip_text the tooltip for this text
|
||||
* @return the new UAT botton
|
||||
* @param uat pointer to the UAT
|
||||
* @return the new UAT button
|
||||
*/
|
||||
GtkWidget *
|
||||
create_preference_uat(GtkWidget *main_tb, int table_position,
|
||||
|
|
|
@ -33,7 +33,7 @@
|
|||
|
||||
/** User requested the "Configuration Profiles" popup menu.
|
||||
*
|
||||
* @param widget parent widget
|
||||
* @param w parent widget
|
||||
* @param event button event
|
||||
* @param user_data pointer to user_data (unused)
|
||||
*/
|
||||
|
|
|
@ -38,14 +38,14 @@ extern void proto_help_init(void);
|
|||
* @param widget Context menu root
|
||||
* @return void
|
||||
*/
|
||||
extern void proto_help_menu_init(GtkWidget *);
|
||||
extern void proto_help_menu_init(GtkWidget *widget);
|
||||
|
||||
/** Fill in the protocol help menu
|
||||
*
|
||||
* @param selection Currently-selected packet
|
||||
* @param cf Capture file
|
||||
* @param cfile Capture file
|
||||
* @return void
|
||||
*/
|
||||
extern void proto_help_menu_modify(GtkTreeSelection*, capture_file *cfile);
|
||||
extern void proto_help_menu_modify(GtkTreeSelection* selection, capture_file *cfile);
|
||||
|
||||
#endif /* __PROTO_HELP_H__ */
|
||||
|
|
|
@ -161,7 +161,7 @@ extern void display_queued_messages(void);
|
|||
|
||||
/** Show a message in the status bar.
|
||||
*
|
||||
* @param msg Status message
|
||||
* @param msg_format Status message
|
||||
*/
|
||||
extern void simple_status(const gchar *msg_format, ...)
|
||||
G_GNUC_PRINTF(1, 2);
|
||||
|
|
Loading…
Reference in New Issue