Fork us on GitHub Follow us on Facebook Follow us on Twitter

Changeset 2177b39 in mainline


Ignore:
Timestamp:
2021-08-08T21:51:33Z (2 months ago)
Author:
Jiri Svoboda <jiri@…>
Branches:
master
Children:
241ab7e
Parents:
a7f7b9c3
Message:

Add missing docblocks

File:
1 edited

Legend:

Unmodified
Added
Removed
  • uspace/lib/inet/src/eth_addr.c

    ra7f7b9c3 r2177b39  
    3939#include <stdio.h>
    4040
     41/** Ethernet broadcast address */
    4142const eth_addr_t eth_addr_broadcast =
    4243    ETH_ADDR_INITIALIZER(0xff, 0xff, 0xff, 0xff, 0xff, 0xff);
    4344
     45/** Encode Ethernet address to buffer.
     46 *
     47 * Encode Ethernet address as a sequence of ETH_ADDR_SIZE bytes into a buffer.
     48 *
     49 * @param addr Ethernet address
     50 * @param buf Buffer (ETH_ADDR_SIZE bytes in size) to store bytes
     51 */
    4452void eth_addr_encode(eth_addr_t *addr, void *buf)
    4553{
     
    5462}
    5563
     64/** Decode Ethernet address from buffer.
     65 *
     66 * Decode Ethernet address from a buffer containing a sequence of
     67 * ETH_ADDR_SIZE bytes.
     68 *
     69 * @param buf Buffer (ETH_ADDR_SIZE bytes in size)
     70 * @param addr Place to store Ethernet address
     71 */
    5672void eth_addr_decode(const void *buf, eth_addr_t *addr)
    5773{
     
    6783}
    6884
    69 /** Compare ethernet addresses.
     85/** Compare Ethernet addresses.
    7086 *
    71  * @return Non-zero if equal, zero if not equal.
     87 * @param a First address
     88 * @param b Second address,
     89 * @return -1, 0, 1 iff @a a is less than, equal to or greater than @a b,
     90 *         respectively.
    7291 */
    7392int eth_addr_compare(const eth_addr_t *a, const eth_addr_t *b)
     
    81100}
    82101
     102/** Format Ethernet address as a string.
     103 *
     104 * @param addr Ethernet address
     105 * @param saddr Structure for storing string representation
     106 *        of @a addr. The caller can access it as @a saddr->str.
     107 */
    83108void eth_addr_format(eth_addr_t *addr, eth_addr_str_t *saddr)
    84109{
Note: See TracChangeset for help on using the changeset viewer.