Fix warning when generate documentation (doxygen)
authorAlexis La Goutte <alexis.lagoutte@gmail.com>
Mon, 14 Apr 2014 18:20:24 +0000 (20:20 +0200)
committerAnders Broman <a.broman58@gmail.com>
Mon, 14 Apr 2014 20:20:38 +0000 (20:20 +0000)
ui/packet_list_utils.h:32: warning: argument 'IN' of command @param is not found in the argument list of right_justify_column(gint col, capture_file *cf)
ui/packet_list_utils.h:32: warning: argument 'IN' of command @param is not found in the argument list of right_justify_column(gint col, capture_file *cf)
ui/packet_list_utils.h:32: warning: The following parameters of right_justify_column(gint col, capture_file *cf) are not documented:
  parameter 'col'
  parameter 'cf'
ui/packet_list_utils.h:42: warning: argument 'IN' of command @param is not found in the argument list of resolve_column(gint col, capture_file *cf)
ui/packet_list_utils.h:42: warning: argument 'IN' of command @param is not found in the argument list of resolve_column(gint col, capture_file *cf)
ui/packet_list_utils.h:42: warning: The following parameters of resolve_column(gint col, capture_file *cf) are not documented:
  parameter 'col'
  parameter 'cf'

Change-Id: I15c7046a36cc72d9904002946eab4dec81ab6861
Reviewed-on: https://code.wireshark.org/review/1132
Reviewed-by: Anders Broman <a.broman58@gmail.com>
ui/packet_list_utils.h

index c20a41ab5b8994f071c3962be880952daa216a5c..08b6310fa502f6fa27b27213430cc1041fdbec36 100644 (file)
@@ -32,8 +32,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.
  */
@@ -42,8 +42,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.
  */