From 163d2bb7aa86171dc895c303fb02412fc22cafc9 Mon Sep 17 00:00:00 2001 From: Matthias Wachs Date: Thu, 23 Dec 2010 08:45:09 +0000 Subject: [PATCH] doxygen --- src/nat/upnp-commands.c | 4 +++- src/nat/upnp-commands.h | 24 ++++++++++++------------ src/nat/upnp-discover.c | 10 +++------- src/nat/upnp.c | 4 +--- 4 files changed, 19 insertions(+), 23 deletions(-) diff --git a/src/nat/upnp-commands.c b/src/nat/upnp-commands.c index 00655f753..2d9ca6243 100644 --- a/src/nat/upnp-commands.c +++ b/src/nat/upnp-commands.c @@ -227,7 +227,7 @@ get_content_and_header_len (const char *p, int n, * @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 @@ parse_url (const char *url, char *hostname, unsigned short *port, char **path) * @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 */ diff --git a/src/nat/upnp-commands.h b/src/nat/upnp-commands.h index 4f3cdc33c..3d1ebe496 100644 --- a/src/nat/upnp-commands.h +++ b/src/nat/upnp-commands.h @@ -98,6 +98,8 @@ typedef void (*UPNP_command_cb_) (char *response, size_t received, void *cls); * @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 @@ typedef void (*UPNP_get_external_ip_address_cb_) (int error, * @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 @@ UPNP_get_external_ip_address_ (const char *control_url, * @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 @@ typedef void (*UPNP_port_mapping_cb_) (int error, * @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 @@ UPNP_add_port_mapping_ (const char *control_url, const char *service_type, * * @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 @@ UPNP_delete_port_mapping_ (const char *control_url, const char *service_type, * @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 @@ typedef void (*UPNP_get_specific_port_mapping_entry_cb_) (int error, * * @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, diff --git a/src/nat/upnp-discover.c b/src/nat/upnp-discover.c index b42df5ff2..654be490e 100644 --- a/src/nat/upnp-discover.c +++ b/src/nat/upnp-discover.c @@ -348,7 +348,7 @@ task_download (void *cls, * * @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 @@ get_valid_igd_connected_cb (char *response, size_t received, void *data) * 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 @@ discover_send (void *data, const struct GNUNET_SCHEDULER_TaskContext *tc); * 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) diff --git a/src/nat/upnp.c b/src/nat/upnp.c index 4435741a0..bdb479da1 100644 --- a/src/nat/upnp.c +++ b/src/nat/upnp.c @@ -338,9 +338,7 @@ get_ip_address_cb (int error, char *ext_addr, void *cls) * * @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, -- 2.25.1