Changeset 01459e4 for lib

Timestamp:

05/26/06 10:30:39 (16 years ago)

Author:

Shane Alcock <salcock@…>

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:

6fb4dbf

Parents:

701e164

Message:

Fixed some documentation errors

File:

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

lib/libtrace.h.in

@@ -894 +894 @@
 libtrace_icmp_t *trace_get_icmp_from_ip(libtrace_ip_t *ip,uint32_t *remaining);
 
-/** Get the destination MAC addres
+/** Get the destination MAC address
  * @param packet        the packet opaque pointer
  * @return a pointer to the destination mac, (or NULL if there is no 
@@ -902 +902 @@
 uint8_t *trace_get_destination_mac(libtrace_packet_t *packet);
 
-/** Get the source MAC addres
+/** Get the source MAC address
  * @param packet        the packet opaque pointer
  * @return a pointer to the source mac, (or NULL if there is no source MAC)
@@ -909 +909 @@
 uint8_t *trace_get_source_mac(libtrace_packet_t *packet);
 
-/** Get the source addres
+/** Get the source IP address
  * @param packet        the packet opaque pointer
  * @param addr          a pointer to a sockaddr to store the address in, or NULL to use
@@ -919 +919 @@
                 struct sockaddr *addr);
 
-/** Get the source addres
+/** Get the destination IP address
  * @param packet        the packet opaque pointer
  * @param addr          a pointer to a sockaddr to store the address in, or NULL to use
  *                      static storage.
- * @return NULL if there is no source address, or a sockaddr holding a v4 or v6 address
+ * @return NULL if there is no destination address, or a sockaddr holding a v4 or v6 address
  */
 DLLEXPORT SIMPLE_FUNCTION