[pisa-src] r2303 - trunk/libpisa/conmgr.c

From: Diego Biurrun <diego@xxxxxxxxxx>
To: pisa-src@xxxxxxxxxxxxx
Date: Mon, 19 Apr 2010 16:13:45 +0200
Author: biurrun
Date: Mon Apr 19 16:13:45 2010
New Revision: 2303

Log:
Add placeholder doxygen entries for undocumented function parameters.

Modified:
   trunk/libpisa/conmgr.c

Modified: trunk/libpisa/conmgr.c
==============================================================================
--- trunk/libpisa/conmgr.c      Mon Apr 19 16:11:07 2010        (r2302)
+++ trunk/libpisa/conmgr.c      Mon Apr 19 16:13:45 2010        (r2303)
@@ -84,7 +84,9 @@
 
 /**
  * Set connection data we get only during connection establishment.
+ * @param conlist FIXME: document this parameter
  * @param entry the connection that will be updated
+ * @param data_port FIXME: document this parameter
  * @param client_ipv4 IPv4 on the client
  * @sa pisa_conmgr_remove
  */
@@ -115,8 +117,10 @@
 
 /**
  * Add a new association to the pisa_conmgr module.
+ * @param conlist FIXME: document this parameter
  * @param hit IPv6 address to be associated with the socket
  * @param ctrl_port control port number
+ * @param type FIXME: document this parameter
  * @return pointer to the new assocation
  * @sa pisa_conmgr_remove
  */
@@ -148,6 +152,8 @@
 
 /**
  * Remove given entry from internal set of associations
+ * @param conlist FIXME: document this parameter
+ * @param natlist FIXME: document this parameter
  * @param entry Pointer to the association to be removed
  */
 void pisa_conmgr_remove(struct pisa_conmgr_list *conlist,
@@ -175,6 +181,7 @@
 
 /**
  * Find the association to a given HIT
+ * @param conlist FIXME: document this parameter
  * @param addr the hit we want to find the associated socket for
  * @return the association or NULL, if none is found
  */
@@ -188,6 +195,7 @@
 
 /**
  * Find the association to a given client IPv4 address
+ * @param conlist FIXME: document this parameter
  * @param client_ipv4 the IPv4 we want to find the associated socket for
  * @return the association or NULL, if none is found
  */
@@ -205,6 +213,7 @@
  * element of our internal association list that is in the
  * connected state. Data is passed through unaltered to the
  * callback (e.g. to accumulate information)
+ * @param conlist FIXME: document this parameter
  * @param cb Callback function which is called repeatedly
  * @param data passed through unaltered to the callback function
  * @sa fdCallback
[pisa-src] r2303 - trunk/libpisa/conmgr.c

Other related posts:
