https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=16061

            Bug ID: 16061
           Summary: doc/README.dissector: proto_tree_add_bitmask_len()
                    prototype is outdated
           Product: Wireshark
           Version: Git
          Hardware: All
                OS: All
            Status: UNCONFIRMED
          Severity: Trivial
          Priority: Low
         Component: Documentation
          Assignee: bugzilla-ad...@wireshark.org
          Reporter: dev...@davisinstruments.com
  Target Milestone: ---

Build Information:
N/A
--
doc/README.dissector presents a function signature for
proto_tree_add_bitmask_len() that is out of date.

It currently reads:

    proto_item *
    proto_tree_add_bitmask_len(tree, tvb, start, len, header, ett, fields,
        encoding);

In actuality, proto_tree_add_bitmask_len() also expects an expert information
field to display in the case where the decodable length is less than the actual
length of the field, as documented in epan/proto.h

@param exp expert info field used when decodable_len < len.  This also means
this function
        should be called even when tree == NULL

It's not a terrible inconvenience that the function signature in
README.dissector is out of date, but it was confusing that the closest thing to
official API documentation conflicted with the source.

-- 
You are receiving this mail because:
You are watching all bug changes.
___________________________________________________________________________
Sent via:    Wireshark-bugs mailing list <wireshark-bugs@wireshark.org>
Archives:    https://www.wireshark.org/lists/wireshark-bugs
Unsubscribe: https://www.wireshark.org/mailman/options/wireshark-bugs
             mailto:wireshark-bugs-requ...@wireshark.org?subject=unsubscribe

Reply via email to