diff --git a/include/tins/utils/radiotap_parser.h b/include/tins/utils/radiotap_parser.h index 1651173..0a5150e 100644 --- a/include/tins/utils/radiotap_parser.h +++ b/include/tins/utils/radiotap_parser.h @@ -114,7 +114,11 @@ public: RadioTap::option current_option(); /** - * Gets the pointer at which the current option is located + * \brief Gets the pointer at which the current option is located + * + * A past-the-end pointer may be returned in case of malformed input or + * end of data. Its validity must be checked (e.g. using + * \ref RadioTapParser.has_fields) before dereference. */ const uint8_t* current_option_ptr() const;