From: Andre Noll <maan@systemlinux.org>
Date: Sun, 13 Jan 2008 16:10:03 +0000 (+0100)
Subject: doxify acl.c.
X-Git-Tag: v0.3.1~95^2~2
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=73aebb78da7297053f41dba5b3f0cefb33ad248e;p=paraslash.git

doxify acl.c.
---

diff --git a/acl.c b/acl.c
index 552ee0b1..53a4170c 100644
--- a/acl.c
+++ b/acl.c
@@ -37,6 +37,14 @@ static int v4_addr_match(uint32_t addr_1, uint32_t addr_2, uint8_t netmask)
 	return (htonl(addr_1) & mask) == (htonl(addr_2) & mask);
 }
 
+/**
+ * Find out whether the peer name of a given fd belongs to an acl.
+ *
+ * \param fd File descriptor.
+ * \param acl The access control list.
+ *
+ * \return One if \a fd belongs to \a acl, zero otherwise.
+ */
 int acl_lookup(int fd, struct list_head *acl)
 {
 	struct access_info *ai, *tmp;
@@ -59,6 +67,13 @@ no_match:
 	return 0;
 }
 
+/**
+ * Add an entry to an access control list.
+ *
+ * \param acl The access control list.
+ * \param addr The address to add.
+ * \param netmask The netmask to use for this entry.
+ */
 void acl_add_entry(struct list_head *acl, struct in_addr addr,
 		int netmask)
 {
@@ -71,6 +86,13 @@ void acl_add_entry(struct list_head *acl, struct in_addr addr,
 }
 
 
+/**
+ * Delete an entry from an access control list.
+ *
+ * \param acl The access control list.
+ * \param addr The address to delete.
+ * \param netmask The netmask of the entry to be removed from the list.
+ */
 void acl_del_entry(struct list_head *acl, struct in_addr addr,
 		int netmask)
 {
@@ -89,6 +111,14 @@ void acl_del_entry(struct list_head *acl, struct in_addr addr,
 	}
 }
 
+/**
+ * Compute a string containing the contents of an acl.
+ *
+ * \param acl The access control list.
+ *
+ * \return A string containing the contents of \a acl, or \p NULL
+ * if \a acl is empty.
+ */
 char *acl_get_contents(struct list_head *acl)
 {
 	struct access_info *ai, *tmp_ai;
@@ -103,6 +133,13 @@ char *acl_get_contents(struct list_head *acl)
 	return ret;
 }
 
+/**
+ * Initialize an access control list.
+ *
+ * \param acl The list to initialize.
+ * \param acl_info An array of strings of the form ip/netmask.
+ * \param num The number of strings in \a acl_info.
+ */
 void acl_init(struct list_head *acl, char * const *acl_info, int num)
 {
 	int i;