aboutsummaryrefslogtreecommitdiffstats
path: root/wiretap/wtap_opttypes.h
diff options
context:
space:
mode:
authorGuy Harris <gharris@sonic.net>2021-01-30 01:13:14 -0800
committerGuy Harris <gharris@sonic.net>2021-01-30 09:13:52 +0000
commitb8e2005653b19bb13e8cefcb229da7d3750911cf (patch)
tree3dfc86c5252d438d985d589103bad7fc890136ed /wiretap/wtap_opttypes.h
parent9177f0e71a57303db01802d4f0ca6d7bdb473fac (diff)
wiretap: clean up comments.
Remove a trailing blank line while we're at it.
Diffstat (limited to 'wiretap/wtap_opttypes.h')
-rw-r--r--wiretap/wtap_opttypes.h9
1 files changed, 4 insertions, 5 deletions
diff --git a/wiretap/wtap_opttypes.h b/wiretap/wtap_opttypes.h
index c5d7112c68..6008353b34 100644
--- a/wiretap/wtap_opttypes.h
+++ b/wiretap/wtap_opttypes.h
@@ -144,7 +144,7 @@ typedef enum {
WTAP_OPTTYPE_STRING,
WTAP_OPTTYPE_IPv4,
WTAP_OPTTYPE_IPv6,
- WTAP_OPTTYPE_STRUCTURED
+ WTAP_OPTTYPE_STRUCTURED /* option-dependent non-simple format */
} wtap_opttype_e;
typedef enum {
@@ -446,7 +446,7 @@ wtap_block_get_string_option_value(wtap_block_t block, guint option_id, char** v
WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_get_nth_string_option_value(wtap_block_t block, guint option_id, guint idx, char** value) G_GNUC_WARN_UNUSED_RESULT;
-/** Add a "custom" option value to a block
+/** Add a structured option value to a block
*
* @param[in] block Block to which to add the option
* @param[in] option_id Identifier value for option
@@ -458,7 +458,7 @@ wtap_block_get_nth_string_option_value(wtap_block_t block, guint option_id, guin
WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_add_structured_option(wtap_block_t block, guint option_id, void* value, size_t value_size);
-/** Set a "custom" option value in a block
+/** Set a structured option value in a block
*
* @param[in] block Block in which to set the option value
* @param[in] option_id Identifier value for option
@@ -469,7 +469,7 @@ wtap_block_add_structured_option(wtap_block_t block, guint option_id, void* valu
WS_DLL_PUBLIC wtap_opttype_return_val
wtap_block_set_structured_option_value(wtap_block_t block, guint option_id, void* value);
-/** Get a "custom" option value from a block
+/** Get a structured option value from a block
*
* @param[in] block Block from which to get the option value
* @param[in] option_id Identifier value for option
@@ -534,4 +534,3 @@ WS_DLL_PUBLIC void wtap_opttypes_cleanup(void);
#endif /* __cplusplus */
#endif /* WTAP_OPT_TYPES_H */
-