Hi,
Thank you. I've created MR 15081
<https://gitlab.com/wireshark/wireshark/-/merge_requests/15081> to address most
of these concerns. I leave to update to the text the someone more in tune with
the Lua API, I'm not sure what the best way to document this polymorphic beast is.
Thanks,
Jaap
On 3/29/24 7:23 PM, Krefta, Oliver O. - US via Wireshark-dev wrote:
Hi,
I've been using the Wireshark Developer's Guide (
https://www.wireshark.org/docs/wsdg_html/
<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
___________________________________________________________________________
Sent via: Wireshark-dev mailing list <wireshark-dev@wireshark.org>
Archives: https://www.wireshark.org/lists/wireshark-dev
Unsubscribe: https://www.wireshark.org/mailman/options/wireshark-dev
mailto:wireshark-dev-requ...@wireshark.org?subject=unsubscribe
