Changeset 2177b39 in mainline

Timestamp:

2021-08-08T21:51:33Z (3 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

241ab7e

Parents:

a7f7b9c3

Message:

Add missing docblocks

File:

• uspace/lib/inet/src/eth_addr.c (modified) (4 diffs)

uspace/lib/inet/src/eth_addr.c

@@ -39 +39 @@
 #include <stdio.h>
 
+/** Ethernet broadcast address */
 const eth_addr_t eth_addr_broadcast =
     ETH_ADDR_INITIALIZER(0xff, 0xff, 0xff, 0xff, 0xff, 0xff);
 
+/** Encode Ethernet address to buffer.
+ *
+ * Encode Ethernet address as a sequence of ETH_ADDR_SIZE bytes into a buffer.
+ *
+ * @param addr Ethernet address
+ * @param buf Buffer (ETH_ADDR_SIZE bytes in size) to store bytes
+ */
 void eth_addr_encode(eth_addr_t *addr, void *buf)
 {
@@ -54 +62 @@
 }
 
+/** Decode Ethernet address from buffer.
+ *
+ * Decode Ethernet address from a buffer containing a sequence of
+ * ETH_ADDR_SIZE bytes.
+ *
+ * @param buf Buffer (ETH_ADDR_SIZE bytes in size)
+ * @param addr Place to store Ethernet address
+ */
 void eth_addr_decode(const void *buf, eth_addr_t *addr)
 {
@@ -67 +83 @@
 }
 
-/** Compare ethernet addresses.
+/** Compare Ethernet addresses.
  *
- * @return Non-zero if equal, zero if not equal.
+ * @param a First address
+ * @param b Second address,
+ * @return -1, 0, 1 iff @a a is less than, equal to or greater than @a b,
+ *         respectively.
  */
 int eth_addr_compare(const eth_addr_t *a, const eth_addr_t *b)
@@ -81 +100 @@
 }
 
+/** Format Ethernet address as a string.
+ *
+ * @param addr Ethernet address
+ * @param saddr Structure for storing string representation
+ *        of @a addr. The caller can access it as @a saddr->str.
+ */
 void eth_addr_format(eth_addr_t *addr, eth_addr_str_t *saddr)
 {