Added documentation.
authorFlorian Pose <fp@igh-essen.com>
Thu, 28 Feb 2008 14:18:18 +0000
changeset 840 64beeb6ce8e3
parent 839 e0757d452fc9
child 841 6f0cf00d7107
Added documentation.
master/module.c
--- a/master/module.c	Thu Feb 28 13:41:02 2008 +0000
+++ b/master/module.c	Thu Feb 28 14:18:18 2008 +0000
@@ -207,7 +207,10 @@
 /**
  * \return true, if two MAC addresses are equal.
  */
-int ec_mac_equal(const uint8_t *mac1, const uint8_t *mac2)
+int ec_mac_equal(
+        const uint8_t *mac1, /**< First MAC address. */
+        const uint8_t *mac2 /**< Second MAC address. */
+        )
 {
     unsigned int i;
     
@@ -245,7 +248,9 @@
 /**
  * \return true, if the MAC address is all-zero.
  */
-int ec_mac_is_zero(const uint8_t *mac)
+int ec_mac_is_zero(
+        const uint8_t *mac /**< MAC address. */
+        )
 {
     unsigned int i;
     
@@ -261,7 +266,9 @@
 /**
  * \return true, if the given MAC address is the broadcast address.
  */
-int ec_mac_is_broadcast(const uint8_t *mac)
+int ec_mac_is_broadcast(
+        const uint8_t *mac /**< MAC address. */
+        )
 {
     unsigned int i;