[pisa-src] r2302 - in trunk: community-operator/co_client.c community-operator/hipl.c libpisa/nat.c libpisa/pisaconf.c pairing/pisaum/include/management.php
- From: Diego Biurrun <diego@xxxxxxxxxx>
- To: pisa-src@xxxxxxxxxxxxx
- Date: Mon, 19 Apr 2010 16:11:08 +0200
Author: biurrun
Date: Mon Apr 19 16:11:07 2010
New Revision: 2302
Log:
Add doxygen documentation for undocumented function parameters.
Modified:
trunk/community-operator/co_client.c
trunk/community-operator/hipl.c
trunk/libpisa/nat.c
trunk/libpisa/pisaconf.c
trunk/pairing/pisaum/include/management.php
Modified: trunk/community-operator/co_client.c
==============================================================================
--- trunk/community-operator/co_client.c Mon Apr 19 14:48:06 2010
(r2301)
+++ trunk/community-operator/co_client.c Mon Apr 19 16:11:07 2010
(r2302)
@@ -209,7 +209,9 @@
/**
* Terminate community-operator client by receiving signal
- * @param sig signal quit code
+ * @param sig signal quit code
+ * @param info unused
+ * @param ctx unused
*/
static void co_client_quit(UNUSED int sig, UNUSED siginfo_t *info,
UNUSED void *ctx)
Modified: trunk/community-operator/hipl.c
==============================================================================
--- trunk/community-operator/hipl.c Mon Apr 19 14:48:06 2010 (r2301)
+++ trunk/community-operator/hipl.c Mon Apr 19 16:11:07 2010 (r2302)
@@ -77,6 +77,7 @@
* Set the total length of a HIP packet.
*
* @param msg HIP message
+ * @param len packet length
*/
static void hip_set_msg_total_len(struct hip_common *msg, uint16_t len)
{
Modified: trunk/libpisa/nat.c
==============================================================================
--- trunk/libpisa/nat.c Mon Apr 19 14:48:06 2010 (r2301)
+++ trunk/libpisa/nat.c Mon Apr 19 16:11:07 2010 (r2302)
@@ -119,6 +119,7 @@
/**
* Find a NAT mapping based on the remote HIT and the remote IPv4 address.
+ * @param natlist list of NAT mappings
* @param remote_hit remote HIT
* @param remote_ipv4 remote IPV4
* @return NAT mapping entry
@@ -138,6 +139,7 @@
/**
* Find a NAT mapping based on a local private IPv4 address.
+ * @param natlist list of NAT mappings
* @param local_private local private IPv4 address
* @return NAT mapping entry
*/
@@ -261,6 +263,7 @@
/**
* Remove all NAT mappings for a given HIT from the list.
+ * @param natlist list of NAT mappings
* @param remote_hit the remote public IPv6 address (HIT)
*/
void pisa_nat_del_mappings_for_hit(struct pisa_nat_list *natlist,
@@ -280,6 +283,7 @@
/**
* Update the connection for a NAT mapping. Used when a legacy client had a
* handover, so we know where to route packets for that client.
+ * @param natlist list of NAT mappings
* @param map mapping that needs to be updated
* @param entry the new connection for that mapping
* @param src new source IP address for the legacy client
Modified: trunk/libpisa/pisaconf.c
==============================================================================
--- trunk/libpisa/pisaconf.c Mon Apr 19 14:48:06 2010 (r2301)
+++ trunk/libpisa/pisaconf.c Mon Apr 19 16:11:07 2010 (r2302)
@@ -412,6 +412,7 @@
* Read a file and interpret each line as arguments to a pisa{s,c}dconf
* command.
* @param filename name of the file containing the configuration
+ * @param parse callback function that does the actual parsing
*/
void pisa_conf_read_file(const char *filename, pisa_conf_parse_cb parse)
{
Modified: trunk/pairing/pisaum/include/management.php
==============================================================================
--- trunk/pairing/pisaum/include/management.php Mon Apr 19 14:48:06 2010
(r2301)
+++ trunk/pairing/pisaum/include/management.php Mon Apr 19 16:11:07 2010
(r2302)
@@ -150,6 +150,7 @@
* Adds a new entry to the configuration file
*
* @param hit The HIT of the new entry
+ * @param expires expiration date or 1 for default expiration date
* @param username The name of the user
* (can be NULL if only a HIT-entry should be added)
* @param active The active status of the user
@@ -300,7 +301,7 @@
* 0: inactive
* 1: active
* 2: no change
- * @param expires The new expiration date or 1 for default expiration date
+ * @param expiration The new expiration date or 1 for default expiration
date
*/
public function
changeActive($username=NULL,$hit=NULL,$active=2,$expiration=1)
{
Other related posts:
- » [pisa-src] r2302 - in trunk: community-operator/co_client.c community-operator/hipl.c libpisa/nat.c libpisa/pisaconf.c pairing/pisaum/include/management.php - Diego Biurrun
