All of lore.kernel.org
 help / color / mirror / Atom feed
From: Duncan Roe <duncan_roe@optusnet.com.au>
To: pablo@netfilter.org
Cc: netfilter-devel@vger.kernel.org
Subject: [PATCH libnetfilter_log 0/1] src: doc: Eliminate doxygen warnings
Date: Wed,  1 Sep 2021 18:22:11 +1000	[thread overview]
Message-ID: <20210901082212.20830-1-duncan_roe@optusnet.com.au> (raw)

This patch only fixes doxygen warnings and associated obviously-wrong lines.

I couldn't help noticing that many functions have an `nfad` argument which is
*always* of type struct nflog_data* but *sometimes* described as
"pointer to logging data" and (more often) as
"Netlink packet data handle passed to callback function".

These can't both be right. I suspect "pointer to logging data" is right but can
someone please confirm?

The discrepancy does not cause a doxygen warning so is not addresssed in this
patch.

Duncan Roe (1):
  src: doc: Eliminate doxygen warnings

 src/libnetfilter_log.c | 28 ++++++++++++++++++++--------
 1 file changed, 20 insertions(+), 8 deletions(-)

-- 
2.17.5


             reply	other threads:[~2021-09-01  8:22 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-01  8:22 Duncan Roe [this message]
2021-09-01  8:22 ` [PATCH libnetfilter_log 1/1] src: doc: Eliminate doxygen warnings Duncan Roe
2021-09-06 10:03   ` Pablo Neira Ayuso

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210901082212.20830-1-duncan_roe@optusnet.com.au \
    --to=duncan_roe@optusnet.com.au \
    --cc=netfilter-devel@vger.kernel.org \
    --cc=pablo@netfilter.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.