Fix warnings caused by incorrect param names / undocumented params
This commit is contained in:
parent
45ec3ea9d9
commit
fb22e15844
|
@ -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
|
* drawn, in screen coordinates (line 1 is the first line below the
|
||||||
* menus)
|
* menus)
|
||||||
*
|
*
|
||||||
|
* \param draw_borders The border style
|
||||||
*/
|
*/
|
||||||
void ctk_draw_window(struct ctk_window *window,
|
void ctk_draw_window(struct ctk_window *window,
|
||||||
unsigned char focus,
|
unsigned char focus,
|
||||||
|
|
|
@ -77,7 +77,7 @@ unsigned short crc16_add(unsigned char b, unsigned short crc);
|
||||||
* \brief Calculate the CRC16 over a data area
|
* \brief Calculate the CRC16 over a data area
|
||||||
* \param data Pointer to the data
|
* \param data Pointer to the data
|
||||||
* \param datalen The length of 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.
|
* \return The CRC16 checksum.
|
||||||
*
|
*
|
||||||
* This function calculates the CRC16 checksum of a data area.
|
* This function calculates the CRC16 checksum of a data area.
|
||||||
|
|
|
@ -142,7 +142,7 @@ int simple_udp_sendto(struct simple_udp_connection *c,
|
||||||
* \param data A pointer to the data to be sent
|
* \param data A pointer to the data to be sent
|
||||||
* \param datalen The length of the data
|
* \param datalen The length of the data
|
||||||
* \param to The IP address of the receiver
|
* \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
|
* This function sends a UDP packet to a specified IP
|
||||||
* address and UDP port. The packet will be sent with the
|
* address and UDP port. The packet will be sent with the
|
||||||
|
|
|
@ -2172,7 +2172,7 @@ CCIF extern uip_lladdr_t uip_lladdr;
|
||||||
*
|
*
|
||||||
* See RFC1071.
|
* 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.
|
* computed.
|
||||||
*
|
*
|
||||||
* \param len The length of the buffer over which the checksum is to
|
* \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.
|
* \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.
|
* Calculate the IP header checksum of the packet header in uip_buf.
|
||||||
|
|
|
@ -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,
|
* \note This function is not called in the current version of uIP,
|
||||||
* but future versions might make use of it.
|
* 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.
|
* computed.
|
||||||
*
|
*
|
||||||
* \param len The length of the buffer over which the checksum is to
|
* \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.
|
* \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.
|
* Calculate the IP header checksum of the packet header in uip_buf.
|
||||||
|
|
|
@ -64,12 +64,13 @@ uint32_t anti_replay_get_counter(void);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Initializes the anti-replay information about the sender
|
* \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);
|
void anti_replay_init_info(struct anti_replay_info *info);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Checks if received frame was replayed
|
* \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
|
* \retval 0 <-> received frame was not replayed
|
||||||
*/
|
*/
|
||||||
int anti_replay_was_replayed(struct anti_replay_info *info);
|
int anti_replay_was_replayed(struct anti_replay_info *info);
|
||||||
|
|
|
@ -131,6 +131,7 @@ void announcement_remove(struct announcement *a);
|
||||||
* \brief Set the value of an announcement
|
* \brief Set the value of an announcement
|
||||||
* \param a A pointer to a struct announcement that has
|
* \param a A pointer to a struct announcement that has
|
||||||
* previously been registered
|
* previously been registered
|
||||||
|
* \param value The new value
|
||||||
*
|
*
|
||||||
* This function sets the value of an announcement that
|
* This function sets the value of an announcement that
|
||||||
* has previously been registered with
|
* has previously been registered with
|
||||||
|
|
|
@ -105,7 +105,7 @@ struct dsc {
|
||||||
*
|
*
|
||||||
* \param prgname The name of the program on disk.
|
* \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.
|
* program.
|
||||||
*
|
*
|
||||||
* \param icon A pointer to the CTK icon.
|
* \param icon A pointer to the CTK icon.
|
||||||
|
|
|
@ -335,7 +335,7 @@ struct process {
|
||||||
*
|
*
|
||||||
* \param p A pointer to a process structure.
|
* \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
|
* process
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -85,7 +85,7 @@ void rs232_set_speed(unsigned char speed);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Print a text string on RS232
|
* \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
|
* This function prints a string to RS232. The string must
|
||||||
* be terminated by a null byte. The RS232 module must be
|
* be terminated by a null byte. The RS232 module must be
|
||||||
|
|
Loading…
Reference in a new issue