summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKen-ichirou MATSUZAWA <chamaken@gmail.com>2014-10-24 14:39:28 +0900
committerFlorian Westphal <fw@strlen.de>2014-10-24 11:16:54 +0200
commit72aec11703c7fda93af77cb6356f9692f18f9e9b (patch)
treeb26115b95123d7835dc39993a13aeea36125bd49
parente374664f48724e5b13a848bad5c5353349f0ae38 (diff)
downloadlibmnl-72aec11703c7fda93af77cb6356f9692f18f9e9b.tar.gz
libmnl-72aec11703c7fda93af77cb6356f9692f18f9e9b.zip
doc: minor fix
mnl_attr_ok(): fix return value type mnl_attr_put_u8(): remove unused param - len mnl_attr_put_u8_check(): remove unused param - len mnl_nlmsg_ok(): fix return value type mnl_nlmsg_batch_stop(): not return batch size, but release it Signed-off-by: Ken-ichirou MATSUZAWA <chamas@h4.dion.ne.jp> Signed-off-by: Florian Westphal <fw@strlen.de>
-rw-r--r--src/attr.c4
-rw-r--r--src/nlmsg.c4
2 files changed, 3 insertions, 5 deletions
diff --git a/src/attr.c b/src/attr.c
index c3c57e6..ca2cd25 100644
--- a/src/attr.c
+++ b/src/attr.c
@@ -89,7 +89,7 @@ EXPORT_SYMBOL(mnl_attr_get_payload);
* truncated.
*
* This function does not set errno in case of error since it is intended
- * for iterations. Thus, it returns 1 on success and 0 on error.
+ * for iterations. Thus, it returns true on success and false on error.
*
* The len parameter may be negative in the case of malformed messages during
* attribute iteration, that is why we use a signed integer.
@@ -428,7 +428,6 @@ EXPORT_SYMBOL(mnl_attr_put);
* mnl_attr_put_u8 - add 8-bit unsigned integer attribute to netlink message
* \param nlh pointer to the netlink message
* \param type netlink attribute type
- * \param len netlink attribute payload size
* \param data 8-bit unsigned integer data that is stored by the new attribute
*
* This function updates the length field of the Netlink message (nlmsg_len)
@@ -569,7 +568,6 @@ EXPORT_SYMBOL(mnl_attr_put_check);
* \param nlh pointer to the netlink message
* \param buflen size of buffer which stores the message
* \param type netlink attribute type
- * \param len netlink attribute payload size
* \param data 8-bit unsigned integer data that is stored by the new attribute
*
* This function first checks that the data can be added to the message
diff --git a/src/nlmsg.c b/src/nlmsg.c
index fdb7af8..fd2f698 100644
--- a/src/nlmsg.c
+++ b/src/nlmsg.c
@@ -150,7 +150,7 @@ EXPORT_SYMBOL(mnl_nlmsg_get_payload_offset);
* truncated.
*
* This function does not set errno in case of error since it is intended
- * for iterations. Thus, it returns 1 on success and 0 on error.
+ * for iterations. Thus, it returns true on success and false on error.
*
* The len parameter may become negative in malformed messages during message
* iteration, that is why we use a signed integer.
@@ -462,7 +462,7 @@ EXPORT_SYMBOL(mnl_nlmsg_batch_start);
* mnl_nlmsg_batch_stop - release a batch
* \param b pointer to batch
*
- * This function returns the amount of data that is part of this batch.
+ * This function releases the batch allocated by mnl_nlmsg_batch_start().
*/
void mnl_nlmsg_batch_stop(struct mnl_nlmsg_batch *b)
{