From ee8bf8f2e9178986ce49c5ebef5545d2d4fb3ad8 Mon Sep 17 00:00:00 2001 From: Duncan Roe Date: Fri, 10 Jan 2020 11:54:43 +1100 Subject: src: doc: Final polish for current round - Ensure all functions that return something have a \returns - Demote more checksum functions to their own groups (reduces number of functions on main pages) - Clarify wording where appropriate - Add \sa (see also) where appropriate - Fix documented function name for nfq_tcp_get_hdr (no other mismatches noticed, but there may be some) - Add warnings regarding changing length of tcp packet - Make group names unique within libnetfilter_queue (else man pages would be overwritten) Signed-off-by: Duncan Roe Signed-off-by: Pablo Neira Ayuso --- src/nlmsg.c | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'src/nlmsg.c') diff --git a/src/nlmsg.c b/src/nlmsg.c index cbf49a6..4f09bf6 100644 --- a/src/nlmsg.c +++ b/src/nlmsg.c @@ -263,9 +263,7 @@ static int nfq_pkt_parse_attr_cb(const struct nlattr *attr, void *data) * nfq_nlmsg_parse - set packet attributes from netlink message * \param nlh netlink message that you want to read. * \param attr pointer to array of attributes to set. - * - * This function returns MNL_CB_ERROR if any error occurs, or MNL_CB_OK on - * success. + * \returns MNL_CB_OK on success or MNL_CB_ERROR if any error occurs. */ EXPORT_SYMBOL int nfq_nlmsg_parse(const struct nlmsghdr *nlh, struct nlattr **attr) -- cgit v1.2.3