From 90a656ed78756316f6339422fbd47703f968b017 Mon Sep 17 00:00:00 2001 From: Dirk Ziegelmeier Date: Mon, 23 May 2016 21:18:16 +0200 Subject: [PATCH] Fix several doxygen errors all over the code --- src/api/api_msg.c | 31 +++++++++++++++---------------- src/api/tcpip.c | 2 +- src/apps/snmp/snmp_asn1.c | 15 ++++++++------- src/apps/snmp/snmp_core.c | 2 +- src/apps/sntp/sntp.c | 10 +++++----- src/core/dns.c | 6 ++++++ src/core/ipv4/autoip.c | 2 +- src/core/pbuf.c | 3 ++- src/core/tcp_out.c | 2 -- 9 files changed, 39 insertions(+), 34 deletions(-) diff --git a/src/api/api_msg.c b/src/api/api_msg.c index 36efa790..9dfea64e 100644 --- a/src/api/api_msg.c +++ b/src/api/api_msg.c @@ -604,7 +604,7 @@ pcb_new(struct api_msg *msg) * Create a new pcb of a specific type inside a netconn. * Called from netconn_new_with_proto_and_callback. * - * @param msg the api_msg_msg describing the connection type + * @param m the api_msg_msg describing the connection type */ void lwip_netconn_do_newconn(void *m) @@ -627,7 +627,6 @@ lwip_netconn_do_newconn(void *m) * The corresponding pcb is NOT created! * * @param t the type of 'connection' to create (@see enum netconn_type) - * @param proto the IP protocol for RAW IP pcbs * @param callback a function to call on status changes (RX available, TX'ed) * @return a newly allocated struct netconn or * NULL on memory error @@ -1000,7 +999,7 @@ lwip_netconn_do_close_internal(struct netconn *conn WRITE_DELAYED_PARAM) * Delete the pcb inside a netconn. * Called from netconn_delete. * - * @param msg the api_msg_msg pointing to the connection + * @param m the api_msg_msg pointing to the connection */ void lwip_netconn_do_delconn(void *m) @@ -1101,8 +1100,8 @@ lwip_netconn_do_delconn(void *m) * Bind a pcb contained in a netconn * Called from netconn_bind. * - * @param msg the api_msg_msg pointing to the connection and containing - * the IP address and port to bind to + * @param m the api_msg_msg pointing to the connection and containing + * the IP address and port to bind to */ void lwip_netconn_do_bind(void *m) @@ -1209,8 +1208,8 @@ lwip_netconn_do_connected(void *arg, struct tcp_pcb *pcb, err_t err) * Connect a pcb contained inside a netconn * Called from netconn_connect. * - * @param msg the api_msg_msg pointing to the connection and containing - * the IP address and port to connect to + * @param m the api_msg_msg pointing to the connection and containing + * the IP address and port to connect to */ void lwip_netconn_do_connect(void *m) @@ -1281,7 +1280,7 @@ lwip_netconn_do_connect(void *m) * Only used for UDP netconns. * Called from netconn_disconnect. * - * @param msg the api_msg_msg pointing to the connection to disconnect + * @param m the api_msg_msg pointing to the connection to disconnect */ void lwip_netconn_do_disconnect(void *m) @@ -1305,7 +1304,7 @@ lwip_netconn_do_disconnect(void *m) * Set a TCP pcb contained in a netconn into listen mode * Called from netconn_listen. * - * @param msg the api_msg_msg pointing to the connection + * @param m the api_msg_msg pointing to the connection */ void lwip_netconn_do_listen(void *m) @@ -1386,7 +1385,7 @@ lwip_netconn_do_listen(void *m) * Send some data on a RAW or UDP pcb contained in a netconn * Called from netconn_send * - * @param msg the api_msg_msg pointing to the connection + * @param m the api_msg_msg pointing to the connection */ void lwip_netconn_do_send(void *m) @@ -1441,7 +1440,7 @@ lwip_netconn_do_send(void *m) * Indicate data has been received from a TCP pcb contained in a netconn * Called from netconn_recv * - * @param msg the api_msg_msg pointing to the connection + * @param m the api_msg_msg pointing to the connection */ void lwip_netconn_do_recv(void *m) @@ -1466,7 +1465,7 @@ lwip_netconn_do_recv(void *m) /** Indicate that a TCP pcb has been accepted * Called from netconn_accept * - * @param msg the api_msg_msg pointing to the connection + * @param m the api_msg_msg pointing to the connection */ void lwip_netconn_do_accepted(void *m) @@ -1643,7 +1642,7 @@ err_mem: * Send some data on a TCP pcb contained in a netconn * Called from netconn_write * - * @param msg the api_msg_msg pointing to the connection + * @param m the api_msg_msg pointing to the connection */ void lwip_netconn_do_write(void *m) @@ -1699,7 +1698,7 @@ lwip_netconn_do_write(void *m) * Return a connection's local or remote address * Called from netconn_getaddr * - * @param msg the api_msg_msg pointing to the connection + * @param m the api_msg_msg pointing to the connection */ void lwip_netconn_do_getaddr(void *m) @@ -1765,7 +1764,7 @@ lwip_netconn_do_getaddr(void *m) * Called from netconn_close * In contrast to closing sockets, the netconn is not deallocated. * - * @param msg the api_msg_msg pointing to the connection + * @param m the api_msg_msg pointing to the connection */ void lwip_netconn_do_close(void *m) @@ -1841,7 +1840,7 @@ lwip_netconn_do_close(void *m) * Join multicast groups for UDP netconns. * Called from netconn_join_leave_group * - * @param msg the api_msg_msg pointing to the connection + * @param m the api_msg_msg pointing to the connection */ void lwip_netconn_do_join_leave_group(void *m) diff --git a/src/api/tcpip.c b/src/api/tcpip.c index c4ad8a5b..76d76019 100644 --- a/src/api/tcpip.c +++ b/src/api/tcpip.c @@ -215,7 +215,7 @@ tcpip_input(struct pbuf *p, struct netif *inp) * A function called in that way may access lwIP core code * without fearing concurrent access. * - * @param f the function to call + * @param function the function to call * @param ctx parameter passed to f * @param block 1 to block until the request is posted, 0 to non-blocking mode * @return ERR_OK if the function was called, another err_t if not diff --git a/src/apps/snmp/snmp_asn1.c b/src/apps/snmp/snmp_asn1.c index f5f10666..afd48b2c 100644 --- a/src/apps/snmp/snmp_asn1.c +++ b/src/apps/snmp/snmp_asn1.c @@ -628,10 +628,11 @@ snmp_asn1_dec_s32t(struct snmp_pbuf_stream *pbuf_stream, u16_t len, s32_t *value /** * Decodes object identifier from incoming message into array of u32_t. * - * @param p points to a pbuf holding an ASN1 coded object identifier - * @param ofs points to the offset within the pbuf chain of the ASN1 coded object identifier + * @param pbuf_stream points to a pbuf stream * @param len length of the coded object identifier - * @param oid return object identifier struct + * @param oid return decoded object identifier + * @param oid_len return decoded object identifier length + * @param oid_max_len size of oid buffer * @return ERR_OK if successful, ERR_ARG if we can't (or won't) decode */ err_t @@ -718,11 +719,11 @@ snmp_asn1_dec_oid(struct snmp_pbuf_stream *pbuf_stream, u16_t len, u32_t* oid, u * Decodes (copies) raw data (ip-addresses, octet strings, opaque encoding) * from incoming message into array. * - * @param p points to a pbuf holding an ASN1 coded raw data - * @param ofs points to the offset within the pbuf chain of the ASN1 coded raw data + * @param pbuf_stream points to a pbuf stream * @param len length of the coded raw data (zero is valid, e.g. empty string!) - * @param raw_len length of the raw return value - * @param raw return raw bytes + * @param buf return raw bytes + * @param buf_len returns length of the raw return value + * @param buf_max_len buffer size * @return ERR_OK if successful, ERR_ARG if we can't (or won't) decode */ err_t diff --git a/src/apps/snmp/snmp_core.c b/src/apps/snmp/snmp_core.c index a4feac85..0f18e3c5 100644 --- a/src/apps/snmp/snmp_core.c +++ b/src/apps/snmp/snmp_core.c @@ -106,7 +106,7 @@ const struct snmp_obj_id* snmp_get_device_enterprise_oid(void) #if LWIP_IPV4 /** * Conversion from InetAddressIPv4 oid to lwIP ip4_addr - * @param ident points to u32_t ident[4] input + * @param oid points to u32_t ident[4] input * @param ip points to output struct */ u8_t diff --git a/src/apps/sntp/sntp.c b/src/apps/sntp/sntp.c index 619549b8..263996a3 100644 --- a/src/apps/sntp/sntp.c +++ b/src/apps/sntp/sntp.c @@ -15,7 +15,7 @@ */ /* - * Copyright (c) 2007-2009 Frédéric Bernon, Simon Goldschmidt + * Copyright (c) 2007-2009 Fr�d�ric Bernon, Simon Goldschmidt * All rights reserved. * * Redistribution and use in source and binary forms, with or without modification, @@ -42,7 +42,7 @@ * * This file is part of the lwIP TCP/IP stack. * - * Author: Frédéric Bernon, Simon Goldschmidt + * Author: Fr�d�ric Bernon, Simon Goldschmidt */ #include "lwip/apps/sntp.h" @@ -618,8 +618,8 @@ sntp_servermode_dhcp(int set_servers_from_dhcp) /** * Initialize one of the NTP servers by IP address * - * @param numdns the index of the NTP server to set must be < SNTP_MAX_SERVERS - * @param dnsserver IP address of the NTP server to set + * @param idx the index of the NTP server to set must be < SNTP_MAX_SERVERS + * @param server IP address of the NTP server to set */ void sntp_setserver(u8_t idx, const ip_addr_t *server) @@ -666,7 +666,7 @@ dhcp_set_ntp_servers(u8_t num, const ip4_addr_t *server) /** * Obtain one of the currently configured by IP address (or DHCP) NTP servers * - * @param numdns the index of the NTP server + * @param idx the index of the NTP server * @return IP address of the indexed NTP server or "ip_addr_any" if the NTP * server has not been configured by address (or at all). */ diff --git a/src/core/dns.c b/src/core/dns.c index c1580f9b..03682a96 100644 --- a/src/core/dns.c +++ b/src/core/dns.c @@ -1399,6 +1399,12 @@ dns_gethostbyname(const char *hostname, ip_addr_t *addr, dns_found_callback foun } /** Like dns_gethostbyname, but returned address type can be controlled: + * @param hostname the hostname that is to be queried + * @param addr pointer to a ip_addr_t where to store the address if it is already + * cached in the dns_table (only valid if ERR_OK is returned!) + * @param found a callback function to be called on success, failure or timeout (only if + * ERR_INPROGRESS is returned!) + * @param callback_arg argument to pass to the callback function * @param dns_addrtype: - LWIP_DNS_ADDRTYPE_IPV4_IPV6: try to resolve IPv4 first, try IPv6 if IPv4 fails only * - LWIP_DNS_ADDRTYPE_IPV6_IPV4: try to resolve IPv6 first, try IPv4 if IPv6 fails only * - LWIP_DNS_ADDRTYPE_IPV4: try to resolve IPv4 only diff --git a/src/core/ipv4/autoip.c b/src/core/ipv4/autoip.c index f9c8f794..eb17074b 100644 --- a/src/core/ipv4/autoip.c +++ b/src/core/ipv4/autoip.c @@ -127,7 +127,7 @@ static void autoip_start_probing(struct netif *netif); * Using this prevents autoip_start to allocate it using mem_malloc. * * @param netif the netif for which to set the struct autoip - * @param dhcp (uninitialised) dhcp struct allocated by the application + * @param autoip (uninitialised) autoip struct allocated by the application */ void autoip_set_struct(struct netif *netif, struct autoip *autoip) diff --git a/src/core/pbuf.c b/src/core/pbuf.c index 5fcde0c1..300c0da1 100644 --- a/src/core/pbuf.c +++ b/src/core/pbuf.c @@ -348,7 +348,7 @@ pbuf_alloc(pbuf_layer layer, u16_t length, pbuf_type type) #if LWIP_SUPPORT_CUSTOM_PBUF /** Initialize a custom pbuf (already allocated). * - * @param layer flag to define header size + * @param l flag to define header size * @param length size of the pbuf's payload * @param type type of the pbuf (only used to treat the pbuf accordingly, as * this function allocates no memory) @@ -1110,6 +1110,7 @@ pbuf_take(struct pbuf *buf, const void *dataptr, u16_t len) * @param buf pbuf to fill with data * @param dataptr application supplied data buffer * @param len length of the application supplied data buffer + * @param offset offset in pbuf where to copy dataptr to * * @return ERR_OK if successful, ERR_MEM if the pbuf is not big enough */ diff --git a/src/core/tcp_out.c b/src/core/tcp_out.c index ab4cfabd..5a94b236 100644 --- a/src/core/tcp_out.c +++ b/src/core/tcp_out.c @@ -745,8 +745,6 @@ memerr: * * @param pcb Protocol control block for the TCP connection. * @param flags TCP header flags to set in the outgoing segment. - * @param optdata pointer to TCP options, or NULL. - * @param optlen length of TCP options in bytes. */ err_t tcp_enqueue_flags(struct tcp_pcb *pcb, u8_t flags)