[pisa-src] r2295 - in trunk: libpisa/log.c pairing/common.c pisacd/cdpending.c pisacd/cdregister.c pisacd/pisacd.c

  • From: Diego Biurrun <diego@xxxxxxxxxx>
  • To: pisa-src@xxxxxxxxxxxxx
  • Date: Thu, 15 Apr 2010 17:37:37 +0200

Author: biurrun
Date: Thu Apr 15 17:37:37 2010
New Revision: 2295

Log:
Fix function parameter names in doxygen comments.

Modified:
   trunk/libpisa/log.c
   trunk/pairing/common.c
   trunk/pisacd/cdpending.c
   trunk/pisacd/cdregister.c
   trunk/pisacd/pisacd.c

Modified: trunk/libpisa/log.c
==============================================================================
--- trunk/libpisa/log.c Thu Apr 15 17:34:09 2010        (r2294)
+++ trunk/libpisa/log.c Thu Apr 15 17:37:37 2010        (r2295)
@@ -100,7 +100,7 @@
 /**
  * Logs the start of a client connection to the logfile
  * @param hit The HIT of the client
- * @param ip The IPv4 address of the client
+ * @param address The IPv4 address of the client
  */
 void pisa_log_start_connection(const char *hit, struct in_addr *address)
 {
@@ -272,7 +272,7 @@
  * Logs the IPv4 address which was given to the client to a log file
  * and the connection start with the name HIT-nat-YEAR.log.
  * @param hit The Hit of the client
- * @param ip IPv4 address of the client
+ * @param address IPv4 address of the client
  */
 void pisa_log_nat_mapping_start(const char *hit, struct in_addr *address)
 {

Modified: trunk/pairing/common.c
==============================================================================
--- trunk/pairing/common.c      Thu Apr 15 17:34:09 2010        (r2294)
+++ trunk/pairing/common.c      Thu Apr 15 17:37:37 2010        (r2295)
@@ -69,7 +69,7 @@
 
 /**
  * Converts time_t time to EXPIRATION_DATE_FORMAT.
- * @param time Pointer to the time_t time
+ * @param t      Pointer to the time_t time
  * @param buffer Pointer to the buffer holding the formatted string
  *
  * @return 1 -> Success

Modified: trunk/pisacd/cdpending.c
==============================================================================
--- trunk/pisacd/cdpending.c    Thu Apr 15 17:34:09 2010        (r2294)
+++ trunk/pisacd/cdpending.c    Thu Apr 15 17:37:37 2010        (r2295)
@@ -64,7 +64,7 @@
 
 /**
  * Create or find a pending request for a given HIT/type combination.
- * @param addr destination of the pending request
+ * @param entry connection manager entry containing pending request
  * @param type pending packet type
  * @param send_cb callback function to send the pending request
  * @param fail_cb callback function called after reaching the maximum retries
@@ -135,7 +135,7 @@
 
 /**
  * Remove all pending requests for given address
- * @param addr address of pending requests to be deleted
+ * @param entry connection manager entry containing pending requests
  */
 void pisa_pending_remove_by_entry(struct pisa_conmgr_entry *entry)
 {

Modified: trunk/pisacd/cdregister.c
==============================================================================
--- trunk/pisacd/cdregister.c   Thu Apr 15 17:34:09 2010        (r2294)
+++ trunk/pisacd/cdregister.c   Thu Apr 15 17:37:37 2010        (r2295)
@@ -125,7 +125,7 @@
 
 /**
  * Set up a default route with a gateway.
- * @param ipAddress gateway IPv4 address
+ * @param ipv4 gateway IPv4 address
  */
 static void pisa_set_default_route(struct in_addr *ipv4)
 {

Modified: trunk/pisacd/pisacd.c
==============================================================================
--- trunk/pisacd/pisacd.c       Thu Apr 15 17:34:09 2010        (r2294)
+++ trunk/pisacd/pisacd.c       Thu Apr 15 17:37:37 2010        (r2295)
@@ -203,7 +203,7 @@
  * E.g. sending Ctrl-C the first time tries to shut down gracefully. If that
  * for some reason fails, a second Ctrl-C quits immediately.
  *
- * @param quitcode signal quit code
+ * @param signum signal quit code
  */
 static void cd_quit(int signum, UNUSED siginfo_t *siginfo, UNUSED void *ctx)
 {

Other related posts:

  • » [pisa-src] r2295 - in trunk: libpisa/log.c pairing/common.c pisacd/cdpending.c pisacd/cdregister.c pisacd/pisacd.c - Diego Biurrun