From d92e9af91c606cd42c784fe7a2e4f138ed11a053 Mon Sep 17 00:00:00 2001 From: Oleg Hahm Date: Sun, 30 Nov 2014 22:34:50 +0100 Subject: [PATCH] doc: fixed broken param descriptions --- core/include/byteorder.h | 36 ++++++++++++++-------------- core/include/thread.h | 2 +- cpu/native/include/nativenet.h | 2 +- drivers/cc110x_legacy_csma/cc1100.h | 2 +- drivers/include/lm75a-temp-sensor.h | 11 ++++----- drivers/include/nrf24l01p.h | 4 ++-- sys/include/bloom.h | 6 ++--- sys/include/cbor.h | 2 +- sys/include/crypto/aes.h | 24 +++++++++---------- sys/include/crypto/cbcmode.h | 2 +- sys/include/crypto/rc5.h | 6 ++--- sys/include/crypto/twofish.h | 6 ++--- sys/include/tm.h | 13 +++++----- sys/net/include/net_if.h | 4 ++-- sys/net/include/pktqueue.h | 4 ++-- sys/net/include/rpl/rpl_storing.h | 2 +- sys/net/include/sixlowpan/icmp.h | 6 ++--- sys/net/include/sixlowpan/ip.h | 2 -- sys/net/include/socket_base/socket.h | 4 ++-- sys/posix/pnet/include/arpa/inet.h | 6 ++--- sys/posix/pnet/include/sys/socket.h | 2 +- 21 files changed, 72 insertions(+), 74 deletions(-) diff --git a/core/include/byteorder.h b/core/include/byteorder.h index ad39122178..a67dcc2097 100644 --- a/core/include/byteorder.h +++ b/core/include/byteorder.h @@ -230,7 +230,7 @@ static inline uint64_t byteorder_swapll(uint64_t v); * @param[in] v The integer to convert. * @returns Converted integer. */ -static inline uint16_t HTONS(uint16_t a); +static inline uint16_t HTONS(uint16_t v); /** * @brief Convert from host byte order to network byte order, 32 bit. @@ -238,7 +238,7 @@ static inline uint16_t HTONS(uint16_t a); * @param[in] v The integer to convert. * @returns Converted integer. */ -static inline uint32_t HTONL(uint32_t a); +static inline uint32_t HTONL(uint32_t v); /** * @brief Convert from host byte order to network byte order, 64 bit. @@ -246,7 +246,7 @@ static inline uint32_t HTONL(uint32_t a); * @param[in] v The integer to convert. * @returns Converted integer. */ -static inline uint64_t HTONLL(uint64_t a); +static inline uint64_t HTONLL(uint64_t v); /** * @brief Convert from network byte order to host byte order, 16 bit. @@ -254,7 +254,7 @@ static inline uint64_t HTONLL(uint64_t a); * @param[in] v The integer to convert. * @returns Converted integer. */ -static inline uint16_t NTOHS(uint16_t a); +static inline uint16_t NTOHS(uint16_t v); /** * @brief Convert from network byte order to host byte order, 32 bit. @@ -262,7 +262,7 @@ static inline uint16_t NTOHS(uint16_t a); * @param[in] v The integer to convert. * @returns Converted integer. */ -static inline uint32_t NTOHL(uint32_t a); +static inline uint32_t NTOHL(uint32_t v); /** * @brief Convert from network byte order to host byte order, 64 bit. @@ -270,7 +270,7 @@ static inline uint32_t NTOHL(uint32_t a); * @param[in] v The integer to convert. * @returns Converted integer. */ -static inline uint64_t NTOHLL(uint64_t a); +static inline uint64_t NTOHLL(uint64_t v); /* **************************** IMPLEMENTATION ***************************** */ @@ -379,36 +379,36 @@ static inline uint64_t byteorder_ntohll(network_uint64_t v) return _byteorder_swap(v.u64, ll); } -static inline uint16_t HTONS(uint16_t a) +static inline uint16_t HTONS(uint16_t v) { - return byteorder_htons(a).u16; + return byteorder_htons(v).u16; } -static inline uint32_t HTONL(uint32_t a) +static inline uint32_t HTONL(uint32_t v) { - return byteorder_htonl(a).u32; + return byteorder_htonl(v).u32; } -static inline uint64_t HTONLL(uint64_t a) +static inline uint64_t HTONLL(uint64_t v) { - return byteorder_htonll(a).u64; + return byteorder_htonll(v).u64; } -static inline uint16_t NTOHS(uint16_t a) +static inline uint16_t NTOHS(uint16_t v) { - network_uint16_t input = { a }; + network_uint16_t input = { v }; return byteorder_ntohs(input); } -static inline uint32_t NTOHL(uint32_t a) +static inline uint32_t NTOHL(uint32_t v) { - network_uint32_t input = { a }; + network_uint32_t input = { v }; return byteorder_ntohl(input); } -static inline uint64_t NTOHLL(uint64_t a) +static inline uint64_t NTOHLL(uint64_t v) { - network_uint64_t input = { a }; + network_uint64_t input = { v }; return byteorder_ntohll(input); } diff --git a/core/include/thread.h b/core/include/thread.h index ea517df350..18f9006efe 100644 --- a/core/include/thread.h +++ b/core/include/thread.h @@ -72,7 +72,7 @@ * @param[in] stacksize the size of the thread's stack in bytes * @param[in] priority priority of the new thread, lower mean higher priority * @param[in] flags optional flags for the creation of the new thread - * @param[in] function pointer to the code that is executed in the new thread + * @param[in] task_func pointer to the code that is executed in the new thread * @param[in] arg the argument to the function * @param[in] name a human readable descriptor for the thread * diff --git a/cpu/native/include/nativenet.h b/cpu/native/include/nativenet.h index 65ad486ca7..a21862d2cd 100644 --- a/cpu/native/include/nativenet.h +++ b/cpu/native/include/nativenet.h @@ -144,7 +144,7 @@ int16_t nativenet_get_channel(void); /** * Set transceiver pan * - * @param channel the pan + * @param pan the pan * @return the pan */ uint16_t nativenet_set_pan(uint16_t pan); diff --git a/drivers/cc110x_legacy_csma/cc1100.h b/drivers/cc110x_legacy_csma/cc1100.h index 4fbf7326dc..f3d3f7b416 100644 --- a/drivers/cc110x_legacy_csma/cc1100.h +++ b/drivers/cc110x_legacy_csma/cc1100.h @@ -191,7 +191,7 @@ char *cc1100_mode_to_text(uint8_t mode); /** * @brief Convert radio state to textual representation. * - * @param mode The radio state to convert. + * @param state The radio state to convert. * * @return Textual representation of radio state. */ diff --git a/drivers/include/lm75a-temp-sensor.h b/drivers/include/lm75a-temp-sensor.h index b730d6ad15..72614124f3 100644 --- a/drivers/include/lm75a-temp-sensor.h +++ b/drivers/include/lm75a-temp-sensor.h @@ -186,12 +186,11 @@ void lm75A_reset(void); * This function prints the values of all registers over * the rs232 interface. * - * @param[in] external_interr_handler pointer to an external task handler - * which is performed, if an external - * interrupt is occurred and the external - * subroutine is leaved. This parameter - * is optional, the NULL-value can be - * entered. + * @param[in] extern_interrupt_task pointer to an external task handler which + * is performed, if an external interrupt is + * occurred and the external subroutine is + * leaved. This parameter is optional, the + * NULL-value can be entered. */ void lm75A_start_sensor_sampling(void (*extern_interrupt_task)(void)); diff --git a/drivers/include/nrf24l01p.h b/drivers/include/nrf24l01p.h index fc464569fe..03e3db888b 100644 --- a/drivers/include/nrf24l01p.h +++ b/drivers/include/nrf24l01p.h @@ -139,7 +139,7 @@ int nrf24l01p_read_reg(nrf24l01p_t *dev, char reg, char *answer); * * @param[in] dev Transceiver device to use. * @param[in] reg Register address to write to. -* @param[in] answer Byte to write. +* @param[in] write Byte to write. * * @return 1 on success. * @return -1 on error. @@ -155,7 +155,7 @@ int nrf24l01p_write_reg(nrf24l01p_t *dev, char reg, char write); * @param[in] dev Transceiver device to use. * @param[in] spi SPI device to use. * @param[in] ce GPIO pin to use for chip enable. -* @param[in] cs GPIO pin to use for chip select. +* @param[in] csn GPIO pin to use for chip select. * @param[in] irq GPIO pin to use for interrupt request. * * @return 1 on success. diff --git a/sys/include/bloom.h b/sys/include/bloom.h index 25718988a9..251ecb8bc6 100644 --- a/sys/include/bloom.h +++ b/sys/include/bloom.h @@ -153,7 +153,7 @@ typedef struct { * * @param size size of the bit array in the filter * @param num_hashes the number of hash functions - * @param functions varg function pointers, use hashfp_t + * @param ... varg function pointers, use hashfp_t * * @return An allocated bloom filter * @@ -176,7 +176,7 @@ void bloom_del(bloom_t *bloom); * Once a string has been added to the filter, it cannot be "removed"! * * @param bloom Bloom filter - * @param s string to add + * @param buf string to add * @return nothing * */ @@ -212,7 +212,7 @@ void bloom_add(bloom_t *bloom, const uint8_t *buf, size_t len); * can only speak a qualified YES. * * @param bloom Bloom filter - * @param s string to check + * @param buf string to check * @return false if string does not exist in the filter * @return true if string is may be in the filter * diff --git a/sys/include/cbor.h b/sys/include/cbor.h index 927e8d6dd7..48bec77371 100644 --- a/sys/include/cbor.h +++ b/sys/include/cbor.h @@ -288,7 +288,7 @@ size_t cbor_serialize_map(cbor_stream_t *s, size_t map_length); * offset += cbor_deserialize_byte_string(&stream, offset, value2, sizeof(value)); // read value 2 * @endcode * - * @param array_length Where the array length is stored + * @param map_length Where the array length is stored */ size_t cbor_deserialize_map(const cbor_stream_t *s, size_t offset, size_t *map_length); diff --git a/sys/include/crypto/aes.h b/sys/include/crypto/aes.h index 2e057bee35..8717dda2ac 100644 --- a/sys/include/crypto/aes.h +++ b/sys/include/crypto/aes.h @@ -100,12 +100,12 @@ int aes_setup_key(cipher_context_t *context, uint8_t *key, uint8_t keysize); * plainBlock to one blocksize long block of ciphertext which will be * written to the the memory-area pointed to by cipherBlock * - * @param context the cipher_context_t-struct to use for this - * encryption - * @param plainBlock a pointer to the plaintext-block (of size - * blocksize) - * @param cipherBlock a pointer to the place where the ciphertext will - * be stored + * @param context the cipher_context_t-struct to use for this + * encryption + * @param plain_block a pointer to the plaintext-block (of size + * blocksize) + * @param cipher_block a pointer to the place where the ciphertext will + * be stored * * @return 1 or result of aes_set_encrypt_key if it failed */ @@ -118,12 +118,12 @@ int aes_encrypt(cipher_context_t *context, uint8_t *plain_block, * cipherBlock to one blocksize long block of plaintext and stores * the plaintext in the memory-area pointed to by plainBlock * - * @param context the cipher_context_t-struct to use for this - * decryption - * @param cipherBlock a pointer to the ciphertext-block (of size - * blocksize) to be decrypted - * @param plainBlock a pointer to the place where the decrypted - * plaintext will be stored + * @param context the cipher_context_t-struct to use for this + * decryption + * @param cipher_block a pointer to the ciphertext-block (of size + * blocksize) to be decrypted + * @param plain_block a pointer to the place where the decrypted + * plaintext will be stored * * @return 1 or result of ::aes_set_decrypt_key if it failed */ diff --git a/sys/include/crypto/cbcmode.h b/sys/include/crypto/cbcmode.h index 5db9802517..74fbf9bd80 100644 --- a/sys/include/crypto/cbcmode.h +++ b/sys/include/crypto/cbcmode.h @@ -127,7 +127,7 @@ int block_cipher_mode_init(CipherModeContext *context, uint8_t key_size, * invocations of this module which use this particular * key. It also contains the opaque context for the * underlying BlockCipher as well. - * @param keySize key size in bytes. + * @param key_size key size in bytes. * @param key pointer to the key. * @param cipher_index the index of the cipher-algorithm to init in the * (cipher-)archive diff --git a/sys/include/crypto/rc5.h b/sys/include/crypto/rc5.h index dffb9aeb56..04df4b6a8f 100644 --- a/sys/include/crypto/rc5.h +++ b/sys/include/crypto/rc5.h @@ -91,13 +91,13 @@ int rc5_init(cipher_context_t *context, uint8_t blockSize, uint8_t keySize, * 1776 cycles (avg case) * * @param context the cipher_context_t-struct to save the updated key in - * @param plainBlock a plaintext block of blockSize - * @param cipherBlock the resulting ciphertext block of blockSize + * @param plain_block a plaintext block of blockSize + * @param cipher_block the resulting ciphertext block of blockSize * * @return Whether the encryption was successful. Possible failure reasons * include not calling init(). */ -int rc5_encrypt(cipher_context_t *context, uint8_t *block, uint8_t *cipherBlock); +int rc5_encrypt(cipher_context_t *context, uint8_t *plain_block, uint8_t *cipher_block); /** * @brief Decrypts a single block (of blockSize) using the key and the diff --git a/sys/include/crypto/twofish.h b/sys/include/crypto/twofish.h index d7fa9750b2..cf9b71b741 100644 --- a/sys/include/crypto/twofish.h +++ b/sys/include/crypto/twofish.h @@ -218,8 +218,8 @@ typedef struct { * call. It should be passed to future invocations of * this module * which use this particular key. - * @param blockSize size of the block in bytes. - * @param keySize key size in bytes + * @param block_size size of the block in bytes. + * @param key_size key size in bytes * @param key pointer to the key * * @return Whether initialization was successful. The command may be @@ -233,7 +233,7 @@ int twofish_init(cipher_context_t *context, uint8_t block_size, uint8_t key_size * * @param context the CipherContext-struct to save the updated key in * @param key a pointer to the secret key - * @param keysize the length of the secret key + * @param key_size the length of the secret key * * @return SUCCESS */ diff --git a/sys/include/tm.h b/sys/include/tm.h index 5893470bb2..29c950a2c6 100644 --- a/sys/include/tm.h +++ b/sys/include/tm.h @@ -80,17 +80,18 @@ int tm_doomsday(int year) CONST; * @details Illegal dates are not catched. * @param[in] year The year. Probably should be ≥ 1582, but needs to be ≥ 1. * @param[in] mon The month, TM_MON_JAN to TM_MON_DEC. - * @param[in] day The day in the month, 1 to 31. + * @param[in] mday The day in the month, 1 to 31. * @param[out] wday Returns the day of the week. * @param[out] yday Returns the day of the year (Jan 1st is 0). */ void tm_get_wyday(int year, int mon, int mday, int *wday, int *yday); /** - * @brief Fills in `struct tm::tm_wday` and `struct tm::tm_yday` given a date. - * @details `struct tm::tm_year`, `struct tm::tm_mon`, and `struct tm::tm_mday` - * need to be set before you call this function. - * @param[in,out] The datum to operate on. + * @brief Fills in `struct tm::tm_wday` and `struct tm::tm_yday` given a date. + * @details `struct tm::tm_year`, `struct tm::tm_mon`, and `struct + * tm::tm_mday` need to be set before you call this + * function. + * @param[in,out] tm The datum to operate on. */ void tm_fill_derived_values(struct tm *tm); @@ -99,7 +100,7 @@ void tm_fill_derived_values(struct tm *tm); * @details Dates before 1582-10-15 are invalid. * @param[in] year The year. * @param[in] mon The month. - * @param[in] day The day in the month. + * @param[in] mday The day in the month. * @returns 0 iff the date is invalid. */ int tm_is_valid_date(int year, int mon, int mday) CONST; diff --git a/sys/net/include/net_if.h b/sys/net/include/net_if.h index 47554d9944..837c14e5e8 100644 --- a/sys/net/include/net_if.h +++ b/sys/net/include/net_if.h @@ -352,8 +352,8 @@ int net_if_send_packet_long(int if_id, net_if_eui64_t *target, * the destination broadcast address. Choose * NET_IF_TRANS_ADDR_M_SHORT if you are not * sure - * @param[in] packet_data The packet to send - * @param[in] packet_len The length of the packet's data in byte, + * @param[in] payload The packet to send + * @param[in] payload_len The length of the packet's data in byte, * negative number on error. * * @return The number of bytes send on success, negative value on failure diff --git a/sys/net/include/pktqueue.h b/sys/net/include/pktqueue.h index d74ea0913a..935934cca7 100644 --- a/sys/net/include/pktqueue.h +++ b/sys/net/include/pktqueue.h @@ -87,7 +87,7 @@ static inline void pktqueue_init(pktqueue_t *queue) /** * @brief get the packet queue's head without removing it * - * @param[out] root the queue + * @param[out] queue the queue * * @return the head */ @@ -99,7 +99,7 @@ static inline pktqueue_node_t *pktqueue_get_head(pktqueue_t *queue) /** * @brief remove the packet queue's head * - * @param[in] root the queue + * @param[in] queue the queue * * @return the old head */ diff --git a/sys/net/include/rpl/rpl_storing.h b/sys/net/include/rpl/rpl_storing.h index eea5dba401..3ef84242ac 100644 --- a/sys/net/include/rpl/rpl_storing.h +++ b/sys/net/include/rpl/rpl_storing.h @@ -149,7 +149,7 @@ void rpl_recv_dao_ack_mode(void); * * @param[in] destination IPv6-address of the destination of the message. * @param[in] payload Payload of the message. - * @param[in] len Length of the message + * @param[in] p_len Length of the message * @param[in] next_header Index to next header in message. * */ diff --git a/sys/net/include/sixlowpan/icmp.h b/sys/net/include/sixlowpan/icmp.h index 0692ec8997..cce0ada1e7 100644 --- a/sys/net/include/sixlowpan/icmp.h +++ b/sys/net/include/sixlowpan/icmp.h @@ -218,15 +218,15 @@ void icmpv6_send_router_adv(ipv6_addr_t *addr, uint8_t sllao, * *aro* == OPT_ARO add it, else not. */ void icmpv6_send_neighbor_sol(ipv6_addr_t *src, ipv6_addr_t *dest, - ipv6_addr_t *targ, uint8_t slloa, + ipv6_addr_t *targ, uint8_t sllao, uint8_t aro); /** * @brief Send ICMPv6 neighbor advertisement. * * @param[in] src Source address for IPv6 header. - * @param[in] dest Destination address for IPv6 header. - * @param[in] targ Value for target address field of neighbor + * @param[in] dst Destination address for IPv6 header. + * @param[in] tgt Value for target address field of neighbor * advertisement. * @param[in] rso Value for flags field of neighbor advertisement. * @param[in] sllao Flag to include source link-layer address diff --git a/sys/net/include/sixlowpan/ip.h b/sys/net/include/sixlowpan/ip.h index bccd75816e..dc592375a8 100644 --- a/sys/net/include/sixlowpan/ip.h +++ b/sys/net/include/sixlowpan/ip.h @@ -492,7 +492,6 @@ static inline net_if_eui64_t *ipv6_addr_get_iid(const ipv6_addr_t *ipv6_addr, * * @param[in] if_id The interface's ID. * @param[in] addr Address to be added to the interface. - * @param[in] type Type of this address. * @param[in] state Initial state of the address. * @param[in] val_ltime Valid lifetime of this address in seconds. Set 0 * for unspecified. @@ -520,7 +519,6 @@ int ipv6_net_if_add_addr(int if_id, const ipv6_addr_t *addr, * * @param[out] src The best source address for this node (may be * all zero if ther is none). - * @param[in] if_id The interface's ID. * @param[in] dest The destination address for a packet we search * the source address for. */ diff --git a/sys/net/include/socket_base/socket.h b/sys/net/include/socket_base/socket.h index 850a977123..4b66efec55 100644 --- a/sys/net/include/socket_base/socket.h +++ b/sys/net/include/socket_base/socket.h @@ -270,8 +270,8 @@ int32_t socket_base_send(int s, const void *buf, uint32_t len, int flags); * @param[in] len Length of buffer. * @param[in] flags Flags for possible later implementations (currently * unused). - * @param[in] from IPv6 Address to send data to. - * @param[in] fromlen Length of address in *from* in byte (always 16). + * @param[in] to IPv6 Address to send data to. + * @param[in] tolen Length of address in *to* in byte (always 16). * * @return Number of send bytes, -1 on error. */ diff --git a/sys/posix/pnet/include/arpa/inet.h b/sys/posix/pnet/include/arpa/inet.h index 8363f6c7bf..f77cd21009 100644 --- a/sys/posix/pnet/include/arpa/inet.h +++ b/sys/posix/pnet/include/arpa/inet.h @@ -66,7 +66,7 @@ struct in_addr { * The Open Group Base Specification Issue 7, htons * * - * @param[in] hostlong A 16 bit number. + * @param[in] hostshort A 16 bit number. * @return The argument value converted from host to network byte * order. */ @@ -79,7 +79,7 @@ struct in_addr { * The Open Group Base Specification Issue 7, ntohl * * - * @param[in] hostlong A 32-bit integer number. + * @param[in] netlong A 32-bit integer number. * @return The argument value converted from network to host byte * order. */ @@ -92,7 +92,7 @@ struct in_addr { * The Open Group Base Specification Issue 7, ntohs * * - * @param[in] hostlong A 16-bit integer number. + * @param[in] netshort A 16-bit integer number. * @return The argument value converted from network to host byte * order. */ diff --git a/sys/posix/pnet/include/sys/socket.h b/sys/posix/pnet/include/sys/socket.h index 6900449888..2b765dd4ae 100644 --- a/sys/posix/pnet/include/sys/socket.h +++ b/sys/posix/pnet/include/sys/socket.h @@ -406,7 +406,7 @@ ssize_t send(int socket, const void *buffer, size_t length, int flags); * * * @param[in] socket Specifies the socket file descriptor. - * @param[in] buffer Points to the buffer containing the message to send. + * @param[in] message Points to the buffer containing the message to send. * @param[in] length Specifies the length of the message in bytes. * @param[in] flags Specifies the type of message reception. Support * for values other than 0 is not implemented yet.