Wireshark-bugs: [Wireshark-bugs] [Bug 2448] New: wslua: the names of tvbrange:get_*() functions
Date: Thu, 10 Apr 2008 21:31:15 +0000 (GMT)
http://bugs.wireshark.org/bugzilla/show_bug.cgi?id=2448

           Summary: wslua: the names of tvbrange:get_*() functions are
                    incorrectly documented
           Product: Wireshark
           Version: SVN
          Platform: PC
        OS/Version: Linux
            Status: NEW
          Severity: Normal
          Priority: Low
         Component: Documentation
        AssignedTo: wireshark-bugs@xxxxxxxxxxxxx
        ReportedBy: nm127@xxxxxxxxxxx


Build Information:
SVN 24881
--
In the file epan/wslua/wslua_tvb.c the following functions are defined:

    {"uint", TvbRange_get_uint},
    {"le_uint", TvbRange_get_le_uint},
    {"float", TvbRange_get_float},
    {"le_float", TvbRange_get_le_float},
    {"ether", TvbRange_get_ether},
    {"ipv4", TvbRange_get_ipv4},
    {"le_ipv4", TvbRange_get_le_ipv4},
    {"string", TvbRange_get_string},
    {"bytes", TvbRange_get_bytes},

The method names would be:
    tvbrange:uint()
    tvbrange:le_uint()
    tvbrange:float()
    tvbrange:le_float()
    tvbrange:ether()
    tvbrange:ipv4()
    tvbrange:le_ipv4()
    tvbrange:string()
    tvbrange:bytes()

However, the script docbook/make-wsluarm.pl creates the documentation from the
TvbRange_* names instead of the real names. So in the help the following
function names are documented (which will not work):

    tvbrange:get_uint()
    tvbrange:get_le_uint()
    tvbrange:get_float()
    tvbrange:get_le_float()
    tvbrange:get_ether()
    tvbrange:get_ipv4()
    tvbrange:get_le_ipv4()
    tvbrange:get_string()
    tvbrange:get_bytes()


-- 
Configure bugmail: http://bugs.wireshark.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.