[pisa-src] r2297 - in trunk: libpisa/arp.c libpisa/nat.c libpisa/scheduler.c pairing/send.c
- From: Diego Biurrun <diego@xxxxxxxxxx>
- To: pisa-src@xxxxxxxxxxxxx
- Date: Thu, 15 Apr 2010 17:44:28 +0200
Author: biurrun
Date: Thu Apr 15 17:44:27 2010
New Revision: 2297
Log:
Fix some obvious bugs in the doxygen documentation of a bunch of functions.
Modified:
trunk/libpisa/arp.c
trunk/libpisa/nat.c
trunk/libpisa/scheduler.c
trunk/pairing/send.c
Modified: trunk/libpisa/arp.c
==============================================================================
--- trunk/libpisa/arp.c Thu Apr 15 17:42:40 2010 (r2296)
+++ trunk/libpisa/arp.c Thu Apr 15 17:44:27 2010 (r2297)
@@ -29,9 +29,9 @@
static struct pisa_arp_cache_entry *arp_cache = NULL;
/**
- * Convert a string to an ARP entry.
- * @param arp ARP entry
- * @param string ARP in string form
+ * Convert a string to a MAC entry.
+ * @param mac MAC address
+ * @param string MAC in string form
*/
void pisa_mac_parse_string(struct pisa_mac *mac, char *string)
{
@@ -40,8 +40,8 @@
}
/**
- * Convert an ARP entry to a string.
- * @param arp ARP entry
+ * Convert a MAC address to a string.
+ * @param mac MAC address
* @param string destination, expected to have at least ARP_STRLEN chars
* allocated
*/
Modified: trunk/libpisa/nat.c
==============================================================================
--- trunk/libpisa/nat.c Thu Apr 15 17:42:40 2010 (r2296)
+++ trunk/libpisa/nat.c Thu Apr 15 17:44:27 2010 (r2297)
@@ -149,8 +149,9 @@
}
/**
- * Find a NAT mapping based on a local private IPv4 address.
- * @param local_private local private IPv4 address
+ * Find a NAT mapping based on a MAC address.
+ * @param natlist list of all NAT mappings
+ * @param mac MAC address
* @return NAT mapping entry
*/
struct pisa_nat_mapping *pisa_nat_mapping_find_by_mac(struct pisa_nat_list
*natlist,
Modified: trunk/libpisa/scheduler.c
==============================================================================
--- trunk/libpisa/scheduler.c Thu Apr 15 17:42:40 2010 (r2296)
+++ trunk/libpisa/scheduler.c Thu Apr 15 17:44:27 2010 (r2297)
@@ -43,9 +43,10 @@
}
/**
- * Substract @b from @a, keep the result normalized (nanosecond count lower
+ * Subtract two timestamps and keep the result normalized (nanosecond count
lower
* than a billion).
- * Constraint: @b earlier than @a
+ * @param a later timestamp
+ * @param b earlier timestamp
*/
static inline void pisa_timersub(struct timespec *a, struct timespec *b,
struct timespec *res)
Modified: trunk/pairing/send.c
==============================================================================
--- trunk/pairing/send.c Thu Apr 15 17:42:40 2010 (r2296)
+++ trunk/pairing/send.c Thu Apr 15 17:44:27 2010 (r2297)
@@ -151,7 +151,7 @@
* @param hit Pointer for storing the HIT.
* @param ipv6_addr Pointer for storing the IPv6 address.
* @param nickname Pointer for storing the nickname.
- * @param options options
+ * @param request_type type of request
*
* @return 1 if parsing successful and required arguments are present; 0
otherwise (recommend exit program)
*/
Other related posts:
