Changeset 0d1c9cf for lib


Ignore:
Timestamp:
03/23/10 11:42:16 (12 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:
6a5b8a4
Parents:
2b4316b
Message:

More documentation fixes

File:
1 edited

Legend:

Unmodified
Added
Removed

  • lib/libtrace.h.in

    r30892b0 r0d1c9cf  
    293293};
    294294
    295 /* RT protocol packet types */
     295/** RT protocol packet types */
    296296typedef enum {
    297297        TRACE_RT_HELLO          =1, /**< Connection accepted */
    … …  
    11311131
    11321132/** Construct a libtrace packet from a buffer containing the packet payload.
    1133  * @param packet[in,out]        Libtrace Packet object to update with the new
     1133 * @param[in,out] packet        Libtrace Packet object to update with the new
    11341134 *                              data.
    11351135 * @param linktype              The linktype of the packet data.
    … …  
    14391439
    14401440/** Gets a pointer to the payload following a link header
    1441  * @param ip            A pointer to the link layer header
     1441 * @param linkptr       A pointer to the link layer header
    14421442 * @param linktype      The linktype of the link header being examined
    14431443 * @param[out] type     An output variable for the ethernet type
    … …  
    19021902/** Seek within an input trace to a time specified as an ERF timestamp
    19031903 * @param trace         The input trace to seek within
    1904  * @param tv            The time to seek to, as an ERF timestamp
     1904 * @param ts            The time to seek to, as an ERF timestamp
    19051905 *
    19061906 * @return 0 on success, -1 if the seek fails. Use trace_perror() to determine
    … …  
    19571957 * truncation.
    19581958 *
    1959  * @note trace_get_wire_length \em{includes} the Frame Check Sequence. This is
     1959 * @note trace_get_wire_length \em includes the Frame Check Sequence. This is
    19601960 * different behaviour compared to most PCAP-based tools.
    19611961 *
    … …  
    22292229 * MPDU was received by the MAC.
    22302230 *
    2231  * @param link The wireless meta header
     2231 * @param linkptr The wireless meta header
    22322232 * @param linktype The linktype of the wireless meta header passed in
    22332233 * @param[out] tsft The value of the timer synchronisation function.
    … …  
    22392239/** Get the wireless data rate
    22402240 *
    2241  * @param link The wireless meta header
     2241 * @param linkptr The wireless meta header
    22422242 * @param linktype The linktype of the wireless meta header passed in
    22432243 * @param[out] rate The data-rate of the frame in units of 500kbps
    … …  
    22482248
    22492249/** Get the wireless channel frequency
    2250  * @param link The wireless meta header
     2250 * @param linkptr The wireless meta header
    22512251 * @param linktype The linktype of the wireless meta header passed in
    22522252 * @param[out] freq The frequency in MHz of the channel the frame was
    … …  
    22582258
    22592259/** Get the wireless signal strength in dBm
    2260  * @param link The wireless meta header
     2260 * @param linkptr The wireless meta header
    22612261 * @param linktype The linktype of the wireless meta header passed in
    22622262 * @param[out] strength The RF signal power at the antenna, in dB difference
    … …  
    22682268
    22692269/** Get the wireless noise strength in dBm
    2270  * @param link The wireless meta header
     2270 * @param linkptr The wireless meta header
    22712271 * @param linktype The linktype of the wireless meta header passed in
    22722272 * @param[out] strength The RF noise power at the antenna, in dB difference
    … …  
    22782278
    22792279/** Get the wireless signal strength in dB
    2280  * @param link The wireless meta header
     2280 * @param linkptr The wireless meta header
    22812281 * @param linktype The linktype of the wireless meta header passed in
    22822282 * @param[out] strength The RF signal power at the antenna, in dB difference
    … …  
    22882288
    22892289/** Get the wireless noise strength in dB
    2290  * @param link The wireless meta header
     2290 * @param linkptr The wireless meta header
    22912291 * @param linktype The linktype of the wireless meta header passed in
    22922292 * @param[out] strength The RF noise power at the antenna, in dB difference
    … …  
    22982298
    22992299/** Get the wireless transmit attenuation
    2300  * @param link The wireless meta header
     2300 * @param linkptr The wireless meta header
    23012301 * @param linktype The linktype of the wireless meta header passed in
    23022302 * @param[out] attenuation The transmit power as a unitless distance from
    … …  
    23092309
    23102310/** Get the wireless transmit attenuation in dB
    2311  * @param link The wireless meta header
     2311 * @param linkptr The wireless meta header
    23122312 * @param linktype The linktype of the wireless meta header passed in
    23132313 * @param[out] attenuation The transmit power as dB difference from maximum
    … …  
    23192319
    23202320/** Get the wireless transmit power in dBm
    2321  * @param link The wireless meta header
     2321 * @param linkptr The wireless meta header
    23222322 * @param linktype The linktype of the wireless meta header passed in
    23232323 * @param[out] txpower The transmit power as dB from a 1mW reference. This is
    … …  
    23292329
    23302330/** Get the wireless antenna
    2331  * @param link The wireless meta header
     2331 * @param linkptr The wireless meta header
    23322332 * @param linktype The linktype of the wireless meta header passed in
    23332333 * @param[out] antenna The antenna that was used to transmit or receive the
Note: See TracChangeset for help on using the changeset viewer.