Changeset d95447b for lib/libtrace.h

Timestamp:

09/27/04 13:56:08 (17 years ago)

Author:

Daniel Lawson <dlawson@…>

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:

8043ced

Parents:

7e05fbe

Message:

doc tidyups

File:

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

lib/libtrace.h

@@ -66 +66 @@
  * and of zlib which are compiled for largefile support (if you wish to access
  * traces larger than 2 GB). This is left as an exercise for the reader. Debian
- * Woody, at least, does not support large files offsets.
+ * Woody, at least, does not support large file offsets.
  *
  */
@@ -132 +132 @@
 #  elif BYTE_ORDER == BIG_ENDIAN
     u_int16_t doff:4;           
-    u_int16_t res1:4;
-    u_int16_t res2:2;
-    u_int16_t urg:1;
-    u_int16_t ack:1;
-    u_int16_t psh:1;
-    u_int16_t rst:1;
-    u_int16_t syn:1;
-    u_int16_t fin:1;
+    u_int16_t res1:4;           /**< Reserved bits */
+    u_int16_t res2:2;           /**< Reserved */
+    u_int16_t urg:1;            /**< URG flag */
+    u_int16_t ack:1;            /**< ACK flag */
+    u_int16_t psh:1;            /**< PuSH flag */
+    u_int16_t rst:1;            /**< RST flag */
+    u_int16_t syn:1;            /**< SYN flag */
+    u_int16_t fin:1;            /**< FIN flag */
 #  else
 #   error "Adjust your <bits/endian.h> defines"
@@ -159 +159 @@
 struct libtrace_icmp
 {
-  u_int8_t type;                /* message type */
-  u_int8_t code;                /* type sub-code */
-  u_int16_t checksum;
+  u_int8_t type;                /**< message type */
+  u_int8_t code;                /**< type sub-code */
+  u_int16_t checksum;           /**< checksum */
   union
   {
@@ -168 +168 @@
       u_int16_t id;
       u_int16_t sequence;
-    } echo;                     /* echo datagram */
-    u_int32_t   gateway;        /* gateway address */
+    } echo;                     /**< echo datagram */
+    u_int32_t   gateway;        /**< gateway address */
     struct
     {
       u_int16_t unused;
       u_int16_t mtu;
-    } frag;                     /* path mtu discovery */
+    } frag;                     /**< path mtu discovery */
   } un;
 };