Document the tvbuff accessors for IEEE floating-point numbers.
authorguy <guy@f5534014-38df-0310-8fa8-9805f1628bb7>
Wed, 24 Apr 2002 21:53:47 +0000 (21:53 +0000)
committerguy <guy@f5534014-38df-0310-8fa8-9805f1628bb7>
Wed, 24 Apr 2002 21:53:47 +0000 (21:53 +0000)
git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@5246 f5534014-38df-0310-8fa8-9805f1628bb7

doc/README.developer

index fca953c5dc8b8d11a1e3117ca59a39828da3d4f2..acb2e6957475887df17a678c83e15ca627dcad89 100644 (file)
@@ -1,4 +1,4 @@
-$Id: README.developer,v 1.51 2002/03/18 00:20:18 guy Exp $
+$Id: README.developer,v 1.52 2002/04/24 21:53:47 guy Exp $
 
 This file is a HOWTO for Ethereal developers. It describes how to start coding
 a Ethereal protocol dissector and the use some of the important functions and
@@ -105,7 +105,7 @@ code inside
 
 is needed only if you are using the "snprintf()" function.
 
-The "$Id: README.developer,v 1.51 2002/03/18 00:20:18 guy Exp $"
+The "$Id: README.developer,v 1.52 2002/04/24 21:53:47 guy Exp $"
 in the comment will be updated by CVS when the file is
 checked in; it will allow the RCS "ident" command to report which
 version of the file is currently checked out.
@@ -115,7 +115,7 @@ version of the file is currently checked out.
  * Routines for PROTONAME dissection
  * Copyright 2000, YOUR_NAME <YOUR_EMAIL_ADDRESS>
  *
- * $Id: README.developer,v 1.51 2002/03/18 00:20:18 guy Exp $
+ * $Id: README.developer,v 1.52 2002/04/24 21:53:47 guy Exp $
  *
  * Ethereal - Network traffic analyzer
  * By Gerald Combs <gerald@ethereal.com>
@@ -365,6 +365,12 @@ guint16 tvb_get_ntohs(tvbuff_t*, gint offset);
 guint32 tvb_get_ntohl(tvbuff_t*, gint offset);
 guint32 tvb_get_ntoh24(tvbuff_t*, gint offset);
 
+Network-to-host-order access for single-precision and double-precision
+IEEE floating-point numbers:
+
+gfloat tvb_get_ntohieee_float(tvbuff_t*, gint offset);
+gdouble tvb_get_ntohieee_double(tvbuff_t*, gint offset);
+
 Little-Endian-to-host-order access for 16-bit integers (guint16), 32-bit
 integers (guint32), and 24-bit integers:
 
@@ -372,6 +378,12 @@ guint16 tvb_get_letohs(tvbuff_t*, gint offset);
 guint32 tvb_get_letohl(tvbuff_t*, gint offset);
 guint32 tvb_get_letoh24(tvbuff_t*, gint offset);
 
+Little-Endian-to-host-order access for single-precision and
+double-precision IEEE floating-point numbers:
+
+gfloat tvb_get_letohieee_float(tvbuff_t*, gint offset);
+gdouble tvb_get_letohieee_double(tvbuff_t*, gint offset);
+
 NOTE: IPv4 addresses are not to be converted to host byte order before
 being passed to "proto_tree_add_ipv4()".  You should use "tvb_memcpy()"
 to fetch them, not "tvb_get_ntohl()" *OR* "tvb_get_letohl()" - don't,