From c00a12652fc6d1c4273ba3a66f94862cf6512443 Mon Sep 17 00:00:00 2001 From: Alexis La Goutte Date: Sun, 15 Dec 2013 19:07:26 +0000 Subject: [PATCH] Fix warning found by doxygen svn path=/trunk/; revision=54130 --- capture.h | 2 ++ capture_sync.h | 1 + pcapio.h | 6 +++--- ui/gtk/packet_win.h | 1 + ui/packet_list_utils.h | 8 ++++---- ui/preference_utils.h | 1 + ui/qt/qt_ui_utils.h | 2 +- ui/win32/file_dlg_win32.h | 9 +++++++++ 8 files changed, 22 insertions(+), 8 deletions(-) diff --git a/capture.h b/capture.h index f6f205d307..13526780da 100644 --- a/capture.h +++ b/capture.h @@ -63,6 +63,8 @@ capture_callback_remove(capture_callback_t func); * Start a capture session. * * @param capture_opts the numerous capture options + * @param cap_session a handle for the capture session + * @param update_cb update screen * @return TRUE if the capture starts successfully, FALSE otherwise. */ extern gboolean diff --git a/capture_sync.h b/capture_sync.h index 507abfae7d..0a44163122 100644 --- a/capture_sync.h +++ b/capture_sync.h @@ -44,6 +44,7 @@ * * @param capture_opts the options * @param cap_session a handle for the capture session + * @param update_cb update screen * @return TRUE if a capture could be started, FALSE if not */ extern gboolean diff --git a/pcapio.h b/pcapio.h index c02b451f6d..f598d9878f 100644 --- a/pcapio.h +++ b/pcapio.h @@ -62,9 +62,9 @@ pcapng_write_session_header_block(FILE* pfile, /**< Write information */ const char *appname, /**< Application name, Optinon 4 shb_userappl * An UTF-8 string containing the name of the application used to create this section. */ - guint64 section_length, - guint64 *bytes_written, - int *err); + guint64 section_length, /**< Length of section */ + guint64 *bytes_written, /**< Number of written bytes */ + int *err); /**< Error type */ extern gboolean pcapng_write_interface_description_block(FILE* pfile, diff --git a/ui/gtk/packet_win.h b/ui/gtk/packet_win.h index 1dd06e5f2f..c010dd9247 100644 --- a/ui/gtk/packet_win.h +++ b/ui/gtk/packet_win.h @@ -35,6 +35,7 @@ * * @param widget parent widget (unused) * @param reference open current packet or reference packet + * @param editable packet window field are editable */ extern void new_packet_window(GtkWidget *widget, gboolean reference, gboolean editable); diff --git a/ui/packet_list_utils.h b/ui/packet_list_utils.h index 866ff70d8a..fd7bb849f7 100644 --- a/ui/packet_list_utils.h +++ b/ui/packet_list_utils.h @@ -34,8 +34,8 @@ extern "C" { /** * Check to see if a column should be right justified. * - * @param [IN]col The column number. - * @param [IN]cf The capture file containing the packet data. + * @param [IN] col The column number. + * @param [IN] cf The capture file containing the packet data. * * @return TRUE if the column should be right justified, FALSE otherwise. */ @@ -44,8 +44,8 @@ gboolean right_justify_column (gint col, capture_file *cf); /** * Check to see if a column's data should be resolved. * - * @param [IN]col The column number. - * @param [IN]cf The capture file containing the packet data. + * @param [IN] col The column number. + * @param [IN] cf The capture file containing the packet data. * * @return TRUE if resolution is required, FALSE otherwise. */ diff --git a/ui/preference_utils.h b/ui/preference_utils.h index a5bfae682b..34c77d1b58 100644 --- a/ui/preference_utils.h +++ b/ui/preference_utils.h @@ -87,6 +87,7 @@ extern void prefs_main_write(void); * @param fmt column format * @param title column title * @param custom_field column custom field + * @param custom_occurrence custom occurence */ void column_prefs_add_custom(gint fmt, const gchar *title, const gchar *custom_field, diff --git a/ui/qt/qt_ui_utils.h b/ui/qt/qt_ui_utils.h index d307a61fdd..65be35fc87 100644 --- a/ui/qt/qt_ui_utils.h +++ b/ui/qt/qt_ui_utils.h @@ -93,7 +93,7 @@ QString gchar_free_to_qstring(gchar *glib_string); * Round the current size of a font up to its next "smooth" size. * If a smooth size can't be found the font is left unchanged. * - * @font The font to smooth. + * @param font The font to smooth. */ void smooth_font_size(QFont &font); diff --git a/ui/win32/file_dlg_win32.h b/ui/win32/file_dlg_win32.h index 94662ee6e6..fd6efc5949 100644 --- a/ui/win32/file_dlg_win32.h +++ b/ui/win32/file_dlg_win32.h @@ -34,6 +34,8 @@ extern "C" { /** Open the "Open" dialog box. * * @param h_wnd HWND of the parent window. + * @param file_name File name + * @param display_filter a display filter */ gboolean win32_open_file (HWND h_wnd, GString *file_name, GString *display_filter); @@ -68,6 +70,7 @@ 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. @@ -86,12 +89,16 @@ gboolean win32_export_specified_packets_file(HWND h_wnd, /** Open the "Merge" dialog box. * * @param h_wnd HWND of the parent window. + * @param file_name File name + * @param display_filter a display filter + * @param merge_type type of merge */ gboolean win32_merge_file (HWND h_wnd, GString *file_name, GString *display_filter, int *merge_type); /** Open the "Export" dialog box. * * @param h_wnd HWND of the parent window. + * @param cf capture_file Structure for the capture to be saved * @param export_type The export type. */ void win32_export_file (HWND h_wnd, capture_file *cf, export_type_e export_type); @@ -99,6 +106,7 @@ void win32_export_file (HWND h_wnd, capture_file *cf, export_type_e export_type) /** Open the "Export raw bytes" dialog box. * * @param h_wnd HWND of the parent window. + * @param cf capture_file Structure for the capture to be saved */ void win32_export_raw_file (HWND h_wnd, capture_file *cf); @@ -111,6 +119,7 @@ void win32_export_sslkeys_file (HWND h_wnd); /** Open the "Export Color Filters" dialog box * * @param h_wnd HWND of the parent window + * @param cf capture_file Structure for the capture to be saved * @param filter_list the list to export */ void win32_export_color_file(HWND h_wnd, capture_file *cf, gpointer filter_list);