From fb22e1584485aa0c2f5dab4dae588b25c3f49a84 Mon Sep 17 00:00:00 2001 From: George Oikonomou Date: Sun, 15 Feb 2015 17:06:44 +0100 Subject: [PATCH] Fix warnings caused by incorrect param names / undocumented params --- core/ctk/ctk-draw.h | 1 + core/lib/crc16.h | 2 +- core/net/ip/simple-udp.h | 2 +- core/net/ip/uip.h | 4 ++-- core/net/ip/uip_arch.h | 4 ++-- core/net/llsec/anti-replay.h | 3 ++- core/net/rime/announcement.h | 1 + core/sys/dsc.h | 2 +- core/sys/process.h | 2 +- platform/cooja/dev/rs232.h | 2 +- 10 files changed, 13 insertions(+), 10 deletions(-) diff --git a/core/ctk/ctk-draw.h b/core/ctk/ctk-draw.h index 388596cea..cb136a004 100644 --- a/core/ctk/ctk-draw.h +++ b/core/ctk/ctk-draw.h @@ -201,6 +201,7 @@ void ctk_draw_clear_window(struct ctk_window *window, * drawn, in screen coordinates (line 1 is the first line below the * menus) * + * \param draw_borders The border style */ void ctk_draw_window(struct ctk_window *window, unsigned char focus, diff --git a/core/lib/crc16.h b/core/lib/crc16.h index 03aa94ea7..e243f546e 100644 --- a/core/lib/crc16.h +++ b/core/lib/crc16.h @@ -77,7 +77,7 @@ unsigned short crc16_add(unsigned char b, unsigned short crc); * \brief Calculate the CRC16 over a data area * \param data Pointer to the data * \param datalen The length of the data - * \param crc The accumulated CRC that is to be updated (or zero). + * \param acc The accumulated CRC that is to be updated (or zero). * \return The CRC16 checksum. * * This function calculates the CRC16 checksum of a data area. diff --git a/core/net/ip/simple-udp.h b/core/net/ip/simple-udp.h index ad4ac53ac..c28ce3e2c 100644 --- a/core/net/ip/simple-udp.h +++ b/core/net/ip/simple-udp.h @@ -142,7 +142,7 @@ int simple_udp_sendto(struct simple_udp_connection *c, * \param data A pointer to the data to be sent * \param datalen The length of the data * \param to The IP address of the receiver - * \param port The UDP port of the receiver, in host byte order + * \param to_port The UDP port of the receiver, in host byte order * * This function sends a UDP packet to a specified IP * address and UDP port. The packet will be sent with the diff --git a/core/net/ip/uip.h b/core/net/ip/uip.h index cfd095de2..792bec33b 100644 --- a/core/net/ip/uip.h +++ b/core/net/ip/uip.h @@ -2172,7 +2172,7 @@ CCIF extern uip_lladdr_t uip_lladdr; * * See RFC1071. * - * \param buf A pointer to the buffer over which the checksum is to be + * \param data A pointer to the buffer over which the checksum is to be * computed. * * \param len The length of the buffer over which the checksum is to @@ -2180,7 +2180,7 @@ CCIF extern uip_lladdr_t uip_lladdr; * * \return The Internet checksum of the buffer. */ -uint16_t uip_chksum(uint16_t *buf, uint16_t len); +uint16_t uip_chksum(uint16_t *data, uint16_t len); /** * Calculate the IP header checksum of the packet header in uip_buf. diff --git a/core/net/ip/uip_arch.h b/core/net/ip/uip_arch.h index a27548519..352a39711 100644 --- a/core/net/ip/uip_arch.h +++ b/core/net/ip/uip_arch.h @@ -93,7 +93,7 @@ void uip_add32(uint8_t *op32, uint16_t op16); * \note This function is not called in the current version of uIP, * but future versions might make use of it. * - * \param buf A pointer to the buffer over which the checksum is to be + * \param data A pointer to the buffer over which the checksum is to be * computed. * * \param len The length of the buffer over which the checksum is to @@ -101,7 +101,7 @@ void uip_add32(uint8_t *op32, uint16_t op16); * * \return The Internet checksum of the buffer. */ -uint16_t uip_chksum(uint16_t *buf, uint16_t len); +uint16_t uip_chksum(uint16_t *data, uint16_t len); /** * Calculate the IP header checksum of the packet header in uip_buf. diff --git a/core/net/llsec/anti-replay.h b/core/net/llsec/anti-replay.h index 2f8e7b2d8..9211a6e7a 100644 --- a/core/net/llsec/anti-replay.h +++ b/core/net/llsec/anti-replay.h @@ -64,12 +64,13 @@ uint32_t anti_replay_get_counter(void); /** * \brief Initializes the anti-replay information about the sender + * \param info Anti-replay information about the sender */ void anti_replay_init_info(struct anti_replay_info *info); /** * \brief Checks if received frame was replayed - * \param last_counters Anti-replay information about the sender + * \param info Anti-replay information about the sender * \retval 0 <-> received frame was not replayed */ int anti_replay_was_replayed(struct anti_replay_info *info); diff --git a/core/net/rime/announcement.h b/core/net/rime/announcement.h index 759ab8b08..802d1da84 100644 --- a/core/net/rime/announcement.h +++ b/core/net/rime/announcement.h @@ -131,6 +131,7 @@ void announcement_remove(struct announcement *a); * \brief Set the value of an announcement * \param a A pointer to a struct announcement that has * previously been registered + * \param value The new value * * This function sets the value of an announcement that * has previously been registered with diff --git a/core/sys/dsc.h b/core/sys/dsc.h index ad7632390..b8b70433e 100644 --- a/core/sys/dsc.h +++ b/core/sys/dsc.h @@ -105,7 +105,7 @@ struct dsc { * * \param prgname The name of the program on disk. * - * \param initfunc A pointer to the initialization function of the + * \param process A pointer to the initialization function of the * program. * * \param icon A pointer to the CTK icon. diff --git a/core/sys/process.h b/core/sys/process.h index 43547f3bd..2d15ca89c 100644 --- a/core/sys/process.h +++ b/core/sys/process.h @@ -335,7 +335,7 @@ struct process { * * \param p A pointer to a process structure. * - * \param arg An argument pointer that can be passed to the new + * \param data An argument pointer that can be passed to the new * process * */ diff --git a/platform/cooja/dev/rs232.h b/platform/cooja/dev/rs232.h index 5a097c096..d21c549b0 100644 --- a/platform/cooja/dev/rs232.h +++ b/platform/cooja/dev/rs232.h @@ -85,7 +85,7 @@ void rs232_set_speed(unsigned char speed); /** * \brief Print a text string on RS232 - * \param str A pointer to the string that is to be printed + * \param text A pointer to the string that is to be printed * * This function prints a string to RS232. The string must * be terminated by a null byte. The RS232 module must be