[GNUnet-SVN] r14036 - gnunet/src/nat

[gnunet]

Author: wachs
Date: 2010-12-23 09:45:09 +0100 (Thu, 23 Dec 2010)
New Revision: 14036

Modified:
   gnunet/src/nat/upnp-commands.c
   gnunet/src/nat/upnp-commands.h
   gnunet/src/nat/upnp-discover.c
   gnunet/src/nat/upnp.c
Log:
doxygen


Modified: gnunet/src/nat/upnp-commands.c
===================================================================
--- gnunet/src/nat/upnp-commands.c      2010-12-23 08:27:06 UTC (rev 14035)
+++ gnunet/src/nat/upnp-commands.c      2010-12-23 08:45:09 UTC (rev 14036)
@@ -227,7 +227,7 @@
  * @param available number of bytes in buf
  * @param addr address of the sender
  * @param addrlen size of addr
- * @errCode value of errno
+ * @param errCode value of errno
  */
 static void
 UPNP_command_receiver (void *data,
@@ -348,6 +348,8 @@
  * @param service type of the service corresponding to the command
  * @param action action to send
  * @param args arguments for action
+ * @param buffer buffer
+ * @param buf_size buffer size
  * @param caller_cb user callback to trigger when done
  * @param caller_cls closure to pass to caller_cb
  */

Modified: gnunet/src/nat/upnp-commands.h
===================================================================
--- gnunet/src/nat/upnp-commands.h      2010-12-23 08:27:06 UTC (rev 14035)
+++ gnunet/src/nat/upnp-commands.h      2010-12-23 08:45:09 UTC (rev 14036)
@@ -98,6 +98,8 @@
  * @param service type of the service corresponding to the command
  * @param action action to send
  * @param args arguments for action
+ * @param buffer buffer
+ * @param buf_size buffer size
  * @param caller_cb user callback to trigger when done
  * @param caller_cls closure to pass to caller_cb
  */
@@ -128,7 +130,7 @@
  * @param control_url the control URL corresponding to service_type on the 
device
  * @param service_type service type to call the command on
  * @param caller_cb function to call when done
- * @param cls closure passed to caller_cb
+ * @param caller_cls closure passed to caller_cb
  */
 void
 UPNP_get_external_ip_address_ (const char *control_url,
@@ -163,8 +165,8 @@
  * @param error GNUNET_OK on success, another value on error (see above)
  * @param control_url the control URL the command was called on
  * @param service_type service the command was called on
- * @param in_port port on the gateway on the LAN side which was requested
- * @param in_client address in the LAN which was requested
+ * @param ext_port external port
+ * @param inPort port on the gateway on the LAN side which was requested
  * @param proto protocol for which port mapping was requested
  * @param remote_host remote host for which port mapping was requested
  * @param cls the closure passed to the command function
@@ -186,10 +188,11 @@
  * @param ext_port port that should be opened on the WAN side
  * @param in_port port on the gateway on the LAN side which should map ext_port
  * @param in_client address in the LAN to which packets should be redirected
+ * @param desc description
  * @param proto protocol for which to request port mapping
  * @param remote_host remote host for which to request port mapping
  * @param caller_cb function to call when done
- * @param cls closure passed to caller_cb
+ * @param caller_cls closure passed to caller_cb
  */
 void
 UPNP_add_port_mapping_ (const char *control_url, const char *service_type,
@@ -208,8 +211,7 @@
  *
  * @param control_url the control URL the command was called on
  * @param service_type service the command was called on
- * @param in_port port on the gateway on the LAN side which was requested
- * @param in_client address in the LAN which was requested
+ * @param ext_port external port
  * @param proto protocol for which port mapping was requested
  * @param remote_host remote host for which port mapping was requested
  * @param caller_cb function to call when done
@@ -228,10 +230,10 @@
  * @param error GNUNET_OK if port is currently mapped, another value on error
  * @param control_url the control URL the command was called on
  * @param service_type service the command was called on
+ * @param ext_port external port
+ * @param proto protocol for which port mapping was requested
  * @param in_port port on the gateway on the LAN side which was requested
  * @param in_client address in the LAN which was requested
- * @param proto protocol for which port mapping was requested
- * @param remote_host remote host for which port mapping was requested
  * @param cls the closure passed to the command function
  */
 typedef void (*UPNP_get_specific_port_mapping_entry_cb_) (int error,
@@ -253,12 +255,10 @@
  *
  * @param control_url the control URL the command was called on
  * @param service_type service the command was called on
- * @param in_port port on the gateway on the LAN side which was requested
- * @param in_client address in the LAN which was requested
+ * @param ext_port external port
  * @param proto protocol for which port mapping was requested
- * @param remote_host remote host for which port mapping was requested
  * @param caller_cb function to call when done
- * @param cls closure passed to caller_cb
+ * @param callers_cls closure passed to caller_cb
  */
 void
 UPNP_get_specific_port_mapping_entry_ (const char *control_url,

Modified: gnunet/src/nat/upnp-discover.c
===================================================================
--- gnunet/src/nat/upnp-discover.c      2010-12-23 08:27:06 UTC (rev 14035)
+++ gnunet/src/nat/upnp-discover.c      2010-12-23 08:45:09 UTC (rev 14036)
@@ -348,7 +348,7 @@
  *
  * @param url URL of the file to download
  * @param caller_cb user function to call when done
- * @caller_cls closure to pass to caller_cb
+ * @param caller_cls closure to pass to caller_cb
  */
 void
 download_device_description (char *url, download_cb caller_cb,
@@ -777,7 +777,7 @@
  * Then, schedule UPnP command to check whether device is connected.
  *
  * @param desc UPnP IGD description (in XML)
- * @data closure from UPNP_discover()
+ * @param data closure from UPNP_discover()
  */
 static void
 get_valid_igd_receive (char *desc, void *data)
@@ -910,11 +910,7 @@
  * and get their descriptions.
  *
  * @param data closure from UPNP_discover()
- * @buf content of the reply
- * @available number of bytes stored in buf
- * @addr address of the sender
- * @addrlen size of addr
- * @param errCode value of errno
+ * @param tc task context
  */
 static void
 discover_recv (void *data, const struct GNUNET_SCHEDULER_TaskContext *tc)

Modified: gnunet/src/nat/upnp.c
===================================================================
--- gnunet/src/nat/upnp.c       2010-12-23 08:27:06 UTC (rev 14035)
+++ gnunet/src/nat/upnp.c       2010-12-23 08:45:09 UTC (rev 14036)
@@ -338,9 +338,7 @@
  * 
  * @param handle the handle for UPnP object
  * @param is_enabled whether enable port redirection
- * @param doPortCheck FIXME
- * @param ext_addr pointer for returning external IP address.
- *     Will be set to NULL if address could not be found. Don't free the 
sockaddr.
+ * @param doPortCheck do port check
  */
 void
 GNUNET_NAT_UPNP_pulse (struct GNUNET_NAT_UPNP_Handle *handle,