aboutsummaryrefslogtreecommitdiffstats
path: root/epan/column-utils.h
diff options
context:
space:
mode:
authorAnders Broman <anders.broman@ericsson.com>2010-08-30 05:39:02 +0000
committerAnders Broman <anders.broman@ericsson.com>2010-08-30 05:39:02 +0000
commit6d1a0a2e8681eb0ce709a4d164548e865ce32001 (patch)
tree18f621f3211418946010f0b837e26bb0e220190f /epan/column-utils.h
parent6d0780b8ba84c97f08d08b9da65068b2fb715241 (diff)
Doxygen related changes.
svn path=/trunk/; revision=34009
Diffstat (limited to 'epan/column-utils.h')
-rw-r--r--epan/column-utils.h18
1 files changed, 14 insertions, 4 deletions
diff --git a/epan/column-utils.h b/epan/column-utils.h
index 0079e3f744..37148a833a 100644
--- a/epan/column-utils.h
+++ b/epan/column-utils.h
@@ -35,6 +35,10 @@
extern "C" {
#endif /* __cplusplus */
+/** @file
+ * Helper routines for column utility structures and routines.
+ */
+
/** Allocate all the data structures for constructing column data, given
* the number of columns.
*
@@ -82,10 +86,14 @@ extern gboolean col_get_writable(column_info *cinfo);
*/
extern void col_set_writable(column_info *cinfo, const gboolean writable);
-/** Check if the given column be filled with data.
+/**
+ * Checks if the given column can be filled with data.
*
* @param cinfo the current packet row
* @param col the column to use, e.g. COL_INFO
+ *
+ * @deprecated Not needed in new code the check is done in
+ * in the column function calls.
*/
extern gint check_col(column_info *cinfo, const gint col);
@@ -137,15 +145,17 @@ extern void col_add_str(column_info *cinfo, const gint col, const gchar *str);
extern void col_add_fstr(column_info *cinfo, const gint col, const gchar *format, ...)
G_GNUC_PRINTF(3, 4);
-/* For internal Wireshark use only. Not to be called from dissectors. */
+/** For internal Wireshark use only. Not to be called from dissectors. */
void col_custom_set_edt(epan_dissect_t *edt, column_info *cinfo);
-/* For internal Wireshark use only. Not to be called from dissectors. */
+/** For internal Wireshark use only. Not to be called from dissectors. */
void col_custom_prime_edt(epan_dissect_t *edt, column_info *cinfo);
-/* For internal Wireshark use only. Not to be called from dissectors. */
+/** For internal Wireshark use only. Not to be called from dissectors. */
gboolean have_custom_cols(column_info *cinfo);
+/** For internal Wireshark use only. Not to be called from dissectors. */
gboolean col_has_time_fmt(column_info *cinfo, const gint col);
+/** For internal Wireshark use only. Not to be called from dissectors. */
gboolean col_based_on_frame_data(column_info *cinfo, const gint col);
/** Append the given text to a column element, the text will be copied.