aboutsummaryrefslogtreecommitdiffstats
path: root/file.h
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2017-07-16 20:49:01 -0700
committerGuy Harris <guy@alum.mit.edu>2017-07-17 03:49:33 +0000
commit4dd48721ee633fd2db3534ad2e43c00847dce42f (patch)
tree3f6866affdf2e1b12c59ff36746b86a47f640c7c /file.h
parentcdc01b89bf07a5df072d6d0410c4920f857feab7 (diff)
Rename cf_get_comment() to reflect what comment it gets.
Change-Id: Id3b0430a1d462b29833259462536ed4cb0424f77 Reviewed-on: https://code.wireshark.org/review/22662 Reviewed-by: Guy Harris <guy@alum.mit.edu>
Diffstat (limited to 'file.h')
-rw-r--r--file.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/file.h b/file.h
index 0615fc2..2a087fc 100644
--- a/file.h
+++ b/file.h
@@ -693,7 +693,15 @@ const gchar* cf_read_section_comment(capture_file *cf);
*/
void cf_update_section_comment(capture_file *cf, gchar *comment);
-char *cf_get_comment(capture_file *cf, const frame_data *fd);
+/*
+ * Get the comment on a packet (record).
+ * If the comment has been edited, it returns the result of the edit,
+ * otherwise it returns the comment from the file.
+ *
+ * @param cf the capture file
+ * @param fd the frame_data structure for the frame
+ */
+char *cf_get_packet_comment(capture_file *cf, const frame_data *fd);
/**
* Update(replace) the comment on a capture from a frame