Changeset 1286

Timestamp:

10/01/07 14:16:56 (6 years ago)

Author:

spa1

Message:

• Clarified that trace_get_*_length functions return a value in bytes, also updated trace_set_capture_length docs to say the same thing

File:

• trunk/lib/libtrace.h.in (modified) (4 diffs)

trunk/lib/libtrace.h.in

@@ -1424 +1424 @@
  * @{
  */
-/** Get the size of the packet in the trace
+/** Get the size of the packet in the trace (in bytes)
  * @param packet        the packet opaque pointer
  * @return the size of the packet in the trace
@@ -1441 +1441 @@
 size_t trace_get_capture_length(const libtrace_packet_t *packet);
 
-/** Get the size of the packet as it was seen on the wire.
+/** Get the size of the packet as it was seen on the wire (in bytes).
  * @param packet        the packet opaque pointer
  * @return the size of the packet as it was on the wire.
@@ -1456 +1456 @@
 size_t trace_get_wire_length(const libtrace_packet_t *packet);
 
-/** Get the length of the capture framing headers.
+/** Get the length of the capture framing headers (in bytes).
  * @param packet        the packet opaque pointer
  * @return the size of the packet as it was on the wire.
@@ -1467 +1467 @@
 /** Truncate ("snap") the packet at the suggested length
  * @param packet        the packet opaque pointer
- * @param size          the new length of the packet
+ * @param size          the new length of the packet (in bytes)
  * @return the new capture length of the packet, or the original capture
  * length of the packet if unchanged