forked from osmocom/wireshark
Fix a whole bunch of doxygen warnings, mostly typos or renamed parameters.
svn path=/trunk/; revision=49053
This commit is contained in:
parent
098997e5fb
commit
63ef04ec84
|
@ -112,7 +112,7 @@ typedef struct if_stat_cache_s if_stat_cache_t;
|
|||
|
||||
/**
|
||||
* Start gathering capture statistics for the interfaces specified.
|
||||
* @param if_list A GList of if_info_t items
|
||||
* @param capture_opts A structure containing options for the capture.
|
||||
* @return A pointer to the statistics state data.
|
||||
*/
|
||||
extern if_stat_cache_t * capture_stat_start(capture_options *capture_opts);
|
||||
|
|
|
@ -102,7 +102,6 @@ void color_filters_prime_edt(epan_dissect_t *edt);
|
|||
|
||||
/** Colorize a specific packet.
|
||||
*
|
||||
* @param row the row in the packet list
|
||||
* @param edt the dissected packet
|
||||
* @return the matching color filter or NULL
|
||||
*/
|
||||
|
|
|
@ -221,7 +221,7 @@ WS_DLL_PUBLIC void add_ipv6_name(const struct e_in6_addr *addr, const gchar *nam
|
|||
* The file can be added before host_name_lookup_init() is called and
|
||||
* will be re-read each time host_name_lookup_init() is called.
|
||||
*
|
||||
* @param hostspath Absolute path to the hosts file.
|
||||
* @param hosts_file Absolute path to the hosts file.
|
||||
*
|
||||
* @return TRUE if the hosts file can be read.
|
||||
*/
|
||||
|
|
|
@ -101,7 +101,7 @@ expert_add_info_format(packet_info *pinfo, proto_item *pi, int group,
|
|||
|
||||
/** Add an expert info about not dissected "item"
|
||||
Add an expert info tree to a not dissected protocol item.
|
||||
@patam tvb The tvb associated with the item.
|
||||
@param tvb The tvb associated with the item.
|
||||
@param pinfo Packet info of the currently processed packet. May be NULL.
|
||||
@param tree Tree to add the item to
|
||||
@param offset Offset in tvb
|
||||
|
|
|
@ -294,7 +294,7 @@ WS_DLL_PUBLIC void heur_dissector_delete(const char *name, heur_dissector_t diss
|
|||
* @param name the name of the "parent" protocol, e.g. "tcp"
|
||||
* @param dissector the sub-dissector to be disabled/enabled
|
||||
* @param proto the protocol id of the sub-dissector
|
||||
* @param TRUE/FALSE to enable/disable the sub-dissector
|
||||
* @param enabled TRUE/FALSE to enable/disable the sub-dissector
|
||||
*/
|
||||
extern void heur_dissector_set_enabled(const char *name, heur_dissector_t dissector, const int proto, const gboolean enabled);
|
||||
|
||||
|
|
|
@ -509,8 +509,7 @@ char *prefs_pref_type_description(pref_t *pref);
|
|||
/** Fetch a string representation of the preference.
|
||||
*
|
||||
* @param pref A preference.
|
||||
* @param default_val Return the default value if TRUE or the current value
|
||||
* if FALSE.
|
||||
* @param source Which value of the preference to return, see pref_source_t.
|
||||
*
|
||||
* @return A string representation of the preference. Must be g_free()d.
|
||||
*/
|
||||
|
|
|
@ -1982,7 +1982,7 @@ proto_tree_add_bits_item(proto_tree *tree, const int hf_index, tvbuff_t *tvb, co
|
|||
@param hf_index field index. Fields for use with this function should have bitmask==0.
|
||||
@param tvb the tv buffer of the current data
|
||||
@param bit_offset of the first crumb in tvb expressed in bits
|
||||
@param pointer to crumb_spec array
|
||||
@param crumb_spec pointer to crumb_spec array
|
||||
@param return_value if a pointer is passed here the value is returned.
|
||||
@return the newly created item */
|
||||
extern proto_item *
|
||||
|
@ -2002,7 +2002,7 @@ proto_tree_add_split_bits_item_ret_val(proto_tree *tree, const int hf_index, tvb
|
|||
@param hf_index field index. Fields for use with this function should have bitmask==0.
|
||||
@param tvb the tv buffer of the current data
|
||||
@param bit_offset of the first crumb in tvb expressed in bits
|
||||
@param pointer to crumb_spec array
|
||||
@param crumb_spec pointer to crumb_spec array
|
||||
@param index into the crumb_spec array for this crumb */
|
||||
void
|
||||
proto_tree_add_split_bits_crumb(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const guint bit_offset,
|
||||
|
|
|
@ -263,7 +263,7 @@ void IA5_7BIT_decode(unsigned char * dest, const unsigned char* src, int len);
|
|||
/** Copy a string, escaping the 'chr' characters in it
|
||||
*
|
||||
* @param str The string to be copied
|
||||
* @param char The character to be escaped
|
||||
* @param chr The character to be escaped
|
||||
* @return A copy of the string with every original 'chr' being
|
||||
* transformed into double 'chr'.
|
||||
*/
|
||||
|
@ -273,7 +273,7 @@ gchar* ws_strdup_escape_char (const gchar *str, const gchar chr);
|
|||
/** Copy a string, unescaping the 'chr' characters in it
|
||||
*
|
||||
* @param str The string to be copied
|
||||
* @param char The character to be escaped
|
||||
* @param chr The character to be escaped
|
||||
* @return A copy of the string with every occurrence of double 'chr' in
|
||||
* the original string being copied as a single 'chr'.
|
||||
*/
|
||||
|
|
6
file.h
6
file.h
|
@ -143,8 +143,8 @@ cf_read_status_t cf_read(capture_file *cf, gboolean from_save);
|
|||
*
|
||||
* @param cf the capture file from which to read the packet
|
||||
* @param fdata the frame_data structure for the packet in question
|
||||
* @param pseudo_header pointer to a wtap_pseudo_header union into
|
||||
* which to read the packet's pseudo-header
|
||||
* @param phdr pointer to a wtap_pkthdr structure to contain the
|
||||
* packet's pseudo-header and other metadata
|
||||
* @param pd a guin8 array into which to read the packet's raw data
|
||||
* @return TRUE if the read succeeded, FALSE if there was an error
|
||||
*/
|
||||
|
@ -245,7 +245,7 @@ gboolean cf_has_unsaved_data(capture_file *cf);
|
|||
* @param fname the filename to save to
|
||||
* @param save_format the format of the file to save (libpcap, ...)
|
||||
* @param compressed whether to gzip compress the file
|
||||
* @discard_comments TRUE if we should discard comments if the save
|
||||
* @param discard_comments TRUE if we should discard comments if the save
|
||||
* succeeds (because we saved in a format that doesn't support
|
||||
* comments)
|
||||
* @param dont_reopen TRUE if it shouldn't reopen and make that file the
|
||||
|
|
|
@ -43,12 +43,12 @@ extern GdkColor BLACK;
|
|||
/** Initialize the colors. */
|
||||
void colors_init(void);
|
||||
|
||||
#if 0
|
||||
/** Allocate a color from the color map.
|
||||
*
|
||||
* @param new_color the new color
|
||||
* @return TRUE if the allocation succeeded
|
||||
*/
|
||||
#if 0
|
||||
gboolean get_color(GdkColor *new_color);
|
||||
#endif
|
||||
|
||||
|
|
|
@ -79,7 +79,7 @@ extern gboolean file_selection_set_current_folder(GtkWidget *fs, const gchar *fi
|
|||
|
||||
/** Set the current file for a file selection dialog.
|
||||
*
|
||||
* @param fs the file selection dialog from file_selection_new()
|
||||
* @param chooser the file selection dialog from file_selection_new()
|
||||
* @param filename the folder to set
|
||||
* @return TRUE if the folder could be changed successfully
|
||||
*/
|
||||
|
|
|
@ -37,8 +37,6 @@
|
|||
extern void fileset_file_opened(const capture_file *cf);
|
||||
|
||||
/** Disable file set menu items
|
||||
*
|
||||
* @param cf Capture file struct
|
||||
*/
|
||||
extern void fileset_file_closed(void);
|
||||
|
||||
|
|
|
@ -33,13 +33,6 @@ enum {
|
|||
FILTER_EXPRESSION_REINIT_CREATE = 2
|
||||
};
|
||||
|
||||
/** User requested to shift the time of the trace
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param data unused
|
||||
* @param action the function to use
|
||||
*/
|
||||
|
||||
extern void filter_expression_save_dlg(gpointer data);
|
||||
void filter_expression_save_dlg_init(gpointer filter_tb, gpointer filter_te);
|
||||
void filter_expression_reinit(int what);
|
||||
|
|
|
@ -519,7 +519,7 @@ GdkPixbuf *gdk_pixbuf_get_from_surface (cairo_surface_t *surface,
|
|||
|
||||
/**
|
||||
* ws_gtk_box_new:
|
||||
* @param GtkOrientation the box's orientation
|
||||
* @param orientation the box's orientation
|
||||
* @param spacing the number of pixels to put between children
|
||||
* @param homogeneous a boolean value, TRUE to create equal allotments, FALSE for variable allotments
|
||||
*/
|
||||
|
|
|
@ -72,49 +72,49 @@ extern void packet_list_mark_frame_cb(GtkWidget *widget, gpointer data);
|
|||
|
||||
/** Toggle Mark on all displayed packets.
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param w parent widget (unused)
|
||||
* @param data unused
|
||||
*/
|
||||
extern void packet_list_toggle_mark_all_displayed_frames_cb(GtkWidget *w _U_, gpointer data _U_);
|
||||
|
||||
/** Mark all displayed packets.
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param w parent widget (unused)
|
||||
* @param data unused
|
||||
*/
|
||||
extern void packet_list_mark_all_displayed_frames_cb(GtkWidget *w _U_, gpointer data _U_);
|
||||
|
||||
/** UnMark all packets in the capture.
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param w parent widget (unused)
|
||||
* @param data unused
|
||||
*/
|
||||
extern void packet_list_unmark_all_displayed_frames_cb(GtkWidget *w _U_, gpointer data _U_);
|
||||
|
||||
/** Ignore the currently selected packet.
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param widget parent widget
|
||||
* @param data unused
|
||||
*/
|
||||
extern void packet_list_ignore_frame_cb(GtkWidget *widget, gpointer data);
|
||||
|
||||
/** Ignore/Unignore all displayed packets.
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param w parent widget (unused)
|
||||
* @param data unused
|
||||
*/
|
||||
extern void packet_list_ignore_all_displayed_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_);
|
||||
|
||||
/** Un-Time Reference all packets in the capture.
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param w parent widget (unused)
|
||||
* @param data unused
|
||||
*/
|
||||
extern void packet_list_untime_reference_all_frames_cb(GtkWidget *w _U_, gpointer data _U_);
|
||||
|
@ -127,7 +127,6 @@ typedef enum {
|
|||
|
||||
/** Called when user clicks on menu item to copy summary data.
|
||||
*
|
||||
* @param w Not used.
|
||||
* @param data Not used.
|
||||
* @param copy_type Mode in which to copy data (e.g. tab-separated, CSV)
|
||||
*/
|
||||
|
|
|
@ -27,9 +27,8 @@
|
|||
|
||||
/** User requested to shift the time of the trace
|
||||
*
|
||||
* @param widget parent widget (unused)
|
||||
* @param widget parent widget
|
||||
* @param data unused
|
||||
* @param action the function to use
|
||||
*/
|
||||
extern void time_shift_cb(GtkWidget *widget, gpointer data);
|
||||
|
||||
|
|
|
@ -38,6 +38,7 @@ extern "C" {
|
|||
* Copy a preference to its stashed value. Can be called from prefs_pref_foreach().
|
||||
*
|
||||
* @param pref: A preference.
|
||||
* @param unused: unused
|
||||
*/
|
||||
extern guint pref_stash(pref_t *pref, gpointer unused _U_);
|
||||
|
||||
|
@ -56,6 +57,7 @@ extern guint pref_unstash(pref_t *pref, gpointer changed_p);
|
|||
* Can be called from prefs_pref_foreach().
|
||||
*
|
||||
* @param pref A preference.
|
||||
* @param unused: unused
|
||||
*
|
||||
* @return Always returns 0.
|
||||
*/
|
||||
|
@ -63,7 +65,7 @@ extern guint pref_clean_stash(pref_t *pref, gpointer unused _U_);
|
|||
|
||||
/** Set a stashed preference to its default value.
|
||||
*
|
||||
*@pram pref A preference.
|
||||
*@param pref A preference.
|
||||
*/
|
||||
extern void reset_stashed_pref(pref_t *pref);
|
||||
|
||||
|
|
|
@ -61,7 +61,7 @@ void init_profile_list(void);
|
|||
/** User requested the "Configuration Profiles" popup menu.
|
||||
*
|
||||
* @param name Profile name
|
||||
* @param expression Parent profile name
|
||||
* @param parent Parent profile name
|
||||
* @param status Current status
|
||||
* @param is_global Profile is in the global configuration directory
|
||||
* @param from_global Profile is copied from the global configuration directory
|
||||
|
|
|
@ -46,7 +46,7 @@ typedef struct progdlg progdlg_t;
|
|||
* needs in order to manipulate the dialog, and return a pointer to
|
||||
* it.
|
||||
*
|
||||
* @param widget UI widget to associate with the progress dialog, e.g.
|
||||
* @param top_level_window UI widget to associate with the progress dialog, e.g.
|
||||
* the main window.
|
||||
* @param task_title The task to do, e.g. "Loading"
|
||||
* @param item_title The item to do, e.g. "capture.cap"
|
||||
|
@ -64,7 +64,7 @@ progdlg_t *create_progress_dlg(const gpointer top_level_window, const gchar *tas
|
|||
* Create a progress dialog, but only if it's not likely to disappear
|
||||
* immediately. This can be disconcerting for the user.
|
||||
*
|
||||
* @param top_level The top-level window associated with the progress update.
|
||||
* @param top_level_window The top-level window associated with the progress update.
|
||||
* May be NULL.
|
||||
* @param task_title The task to do, e.g. "Loading"
|
||||
* @param item_title The item to do, e.g. "capture.cap"
|
||||
|
|
|
@ -41,7 +41,7 @@ extern void menu_recent_file_write_all(FILE *rf);
|
|||
|
||||
/** Add a capture filter coming from the user's recent file to the cfilter combo box.
|
||||
*
|
||||
* @param dftext the filter string
|
||||
* @param s the filter string
|
||||
*/
|
||||
extern gboolean cfilter_combo_add_recent(const gchar *s);
|
||||
|
||||
|
|
|
@ -40,9 +40,9 @@ gboolean win32_open_file (HWND h_wnd, GString *file_name, GString *display_filte
|
|||
/** Verify that our proposed capture file format supports comments. If it can't
|
||||
* ask the user what to do and return his or her response.
|
||||
*
|
||||
* @param h_wnd HWND of the parent window.
|
||||
* @param parent HWND of the parent window.
|
||||
* @param cf Capture file.
|
||||
* @param file_format Proposed file format.
|
||||
* @param file_type Proposed file format.
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
|
@ -68,7 +68,6 @@ gboolean win32_save_as_file(HWND h_wnd, capture_file *cf,
|
|||
/** Open the "Export Specified Packets" dialog box.
|
||||
*
|
||||
* @param h_wnd HWND of the parent window.
|
||||
* @param cf capture_file Structure for the capture to be saved
|
||||
* @param file_name File name. May be empty.
|
||||
* @param file_type Wiretap file type.
|
||||
* @param compressed Compress the file with gzip.
|
||||
|
|
Loading…
Reference in New Issue