|
Hi,
I've been using the Wireshark Developer's Guide (
https://www.wireshark.org/docs/wsdg_html/ ) as a reference for developing a dissector using the Lua API. In doing so, I noticed a few potential errors in the documentation and wanted to give feedback.
Section 11.6.2.5
My understanding is that tvb:reported_length_remaining() takes an optional parameter specifying an offset. My own testing seems to confirm this. However the function is documented as taking no parameters.
Section 11.7
This section seems to have some formatting issues. Several of the documented API functions are children of the "Example" subsection 11.7.2 when they should be contained in the "TreeItem" subsection 11.7.1.
Additionally, the documentation for treeitem:add() and similar functions have mismatched brackets in the sentence:
This function has a complicated form: 'treeitem:add([protofield,] [tvbrange,] value], label)', such that ...
(In fact that whole paragraph is a bit confusing to understand).
Hopefully you find this useful in improving the documentation.
Thanks,
Oliver Krefta
This electronic message contains information from CACI International Inc or subsidiary companies, which may be company sensitive, proprietary, privileged or otherwise protected from disclosure. The information is intended to be used solely by the recipient(s)
named above. If you are not an intended recipient, be aware that any review, disclosure, copying, distribution or use of this transmission or its contents is prohibited. If you have received this transmission in error, please notify the sender immediately.
|