From 267a4ddaa270747c91b6d20e05bc39073aa4de72 Mon Sep 17 00:00:00 2001 From: Florian Pose Date: Thu, 28 Feb 2008 14:18:18 +0000 Subject: [PATCH] Added documentation. --- master/module.c | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/master/module.c b/master/module.c index 03a6373c..ba95a5ed 100644 --- a/master/module.c +++ b/master/module.c @@ -207,7 +207,10 @@ void __exit ec_cleanup_module(void) /** * \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 @@ ssize_t ec_mac_print( /** * \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 @@ int ec_mac_is_zero(const uint8_t *mac) /** * \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;