Changeset e3a9eb5 for lib/libtrace.h.in


Ignore:
Timestamp:
09/06/07 12:03:25 (14 years ago)
Author:
Scott Raynel <smr26@…>
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:
0aae8f4
Parents:
fbc4342
Message:

Fix up doxygen comments for the new API

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lib/libtrace.h.in

    r9bc4689 re3a9eb5  
    944944
    945945
    946 /* Gets a pointer to the first byte of the packet as it was captured and
     946/** Gets a pointer to the first byte of the packet as it was captured and
    947947 * returns its corresponding linktype and capture length.
    948948 *
     
    950950 *
    951951 * @param packet the packet pointer
    952  * @param linktype[out] the linktype of the returned pointer
    953  * @param remaining[out] the capture length (number of valid bytes from the
     952 * @param[out] linktype the linktype of the returned pointer
     953 * @param[out] remaining the capture length (number of valid bytes from the
    954954 * pointer)
    955955 * @return a pointer to the first byte of the packet
     
    963963 * @return a pointer to the link layer, or NULL if there is no link layer
    964964 *
    965  * @deprecated This function is deprecated. Use trace_get_packet_buffer(..) or
    966  * one of the trace_get_layer*(..) functions instead.
     965 * @deprecated This function is deprecated: Use trace_get_packet_buffer() or
     966 * one of the trace_get_layer*() functions instead.
    967967 * @note you should call trace_get_link_type to find out what type of link
    968968 * layer this is
     
    987987libtrace_ip6_t *trace_get_ip6(libtrace_packet_t *packet);
    988988
    989 /* Return a pointer to the first metadata header in a packet, if present.
     989/** Return a pointer to the first metadata header in a packet, if present.
    990990 *
    991991 * This function takes a pointer to a libtrace packet and if any metadata
     
    10011001 *
    10021002 * @param packet the libtrace packet
    1003  * @param linktype[out] the linktype of the returned metadata header
    1004  * @param remaining[out] the amount of space availabled after this header
     1003 * @param[out] linktype the linktype of the returned metadata header
     1004 * @param[out] remaining the amount of space availabled after this header
    10051005 * @return a pointer to the first metadata header, or NULL if there are no metadata headers present.
    10061006 *
     
    10111011                uint32_t *remaining);
    10121012
    1013 /* Returns the payload of a metadata header.
     1013/** Returns the payload of a metadata header.
    10141014 *
    10151015 * This function takes a pointer to the start of a metadata header (either
     
    10281028 * wireless monitoring header.
    10291029 *
    1030  * @param meta[in] a pointer to a header
    1031  * @param linktype[in,out] the linktype of meta (updated to indicate the
     1030 * @param[in] meta a pointer to a header
     1031 * @param[in,out] linktype the linktype of meta (updated to indicate the
    10321032 * linktype of the returned header if applicable).
    1033  * @param remaining[in,out] the number of bytes after the meta pointer.
     1033 * @param[in,out] remaining the number of bytes after the meta pointer.
    10341034 * @return a pointer to the payload of the metadata header. If meta is not a
    10351035 * pointer to a metadata header, NULL is returned and linktype remains
     
    10431043
    10441044
    1045 /* Get a pointer to the layer 2 header. Generally this is the first byte of the
     1045/** Get a pointer to the layer 2 header. Generally this is the first byte of the
    10461046 * packet as it was seen on the wire.
    10471047 *
     
    10511051 *
    10521052 * @param packet the libtrace packet
    1053  * @param linktype[out] the linktype of the returned layer 2 header
    1054  * @param remaining[out] the number of bytes left in the packet after the
     1053 * @param[out] linktype the linktype of the returned layer 2 header
     1054 * @param[out] remaining the number of bytes left in the packet after the
    10551055 * returned pointer.
    10561056 * @return a pointer to the first byte of the packet as it was seen on the
Note: See TracChangeset for help on using the changeset viewer.