Fix warning found by doxygen
authoralagoutte <alagoutte@f5534014-38df-0310-8fa8-9805f1628bb7>
Sun, 15 Dec 2013 19:07:26 +0000 (19:07 +0000)
committeralagoutte <alagoutte@f5534014-38df-0310-8fa8-9805f1628bb7>
Sun, 15 Dec 2013 19:07:26 +0000 (19:07 +0000)
git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@54130 f5534014-38df-0310-8fa8-9805f1628bb7

capture.h
capture_sync.h
pcapio.h
ui/gtk/packet_win.h
ui/packet_list_utils.h
ui/preference_utils.h
ui/qt/qt_ui_utils.h
ui/win32/file_dlg_win32.h

index f6f205d30726e79f4c453a4c75a1a362e758891c..13526780da4a7d40802c274b5d8cc55e918849f4 100644 (file)
--- 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
index 507abfae7d8cd813a7970e5bdc4004e8534256bf..0a441631224b14a52d2bcc41c583b81d2420cb6c 100644 (file)
@@ -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
index c02b451f6d0361067d14723af9b43c0964a2281c..f598d9878fab64b3047317d169ea48032c12146e 100644 (file)
--- 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,
index 1dd06e5f2f505b4d9c96dde9a8a34213be752472..c010dd9247c310fdd30e73637ed9bf9d5f9d29e3 100644 (file)
@@ -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);
 
index 866ff70d8a97f35425083730a95566ba721e6fe4..fd7bb849f77d91eeaeeb3dbd647906579eea0c3a 100644 (file)
@@ -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.
  */
index a5bfae682bc2ea55615499909b3b9c4f25523378..34c77d1b58b1fb369dc5ef7b93b40cc6e53ec792 100644 (file)
@@ -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,
index d307a61fdd8f3b684f214c935d01ce458e9ec41d..65be35fc8780b2b9ccbcb95ed6bdffce143424f7 100644 (file)
@@ -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);
 
index 94662ee6e68549afd6d5747b90c54db555f2f6bc..fd6efc5949adcb66e48e3649d5d97c98167d34ea 100644 (file)
@@ -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);