Changeset 0d768c8 for lib/libtrace.h

Timestamp:

02/24/06 14:38:51 (16 years ago)

Author:

Perry Lorier <perry@…>

Branches:

4.0.1-hotfixes, cachetimestamps, develop, dpdk-ndag, etsilive, getfragoff, help, libtrace4, master, ndag_format, pfring, rc-4.0.1, rc-4.0.2, rc-4.0.3, rc-4.0.4, ringdecrementfix, ringperformance, ringtimestampfixes

Children:

9de8150

Parents:

2e223eca

Message:

More documentation of fields

File:

• lib/libtrace.h (modified) (2 diffs)

lib/libtrace.h

@@ -104 +104 @@
  */
 typedef struct libtrace_packet_t {
-        struct libtrace_t *trace;
-        void *header;
-        void *payload;
-        buf_control_t buf_control; 
-        void *buffer;
+        struct libtrace_t *trace; /**< pointer to the trace */
+        void *header;           /**< pointer to the framing header */
+        void *payload;          /**< pointer to the link layer */
+        buf_control_t buf_control; /**< who owns the memory */
+        void *buffer;           /**< allocated buffer */
         size_t size;            /**< trace_get_framing_length()
                                  * +trace_get_capture_length() */
@@ -289 +289 @@
 {
  u_int16_t header;
- u_int16_t ether_type;
+ u_int16_t ether_type;          /**< ether type */
 } __attribute__ ((packed)) libtrace_pos;
 /*@}*/