netfilter: nf_tables: Add missing Kernel doc
authorSimon Horman <horms@kernel.org>
Fri, 30 Aug 2024 17:23:00 +0000 (18:23 +0100)
committerPablo Neira Ayuso <pablo@netfilter.org>
Tue, 3 Sep 2024 08:47:17 +0000 (10:47 +0200)
- Add missing documentation of struct field and enum items.
- Add missing documentation of function parameter.

Flagged by ./scripts/kernel-doc -none.

No functional change intended.
Compile tested only.

Signed-off-by: Simon Horman <horms@kernel.org>
Reviewed-by: Florian Westphal <fw@strlen.de>
Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
include/net/netfilter/nf_tables.h
include/net/netfilter/nf_tproxy.h

index 02626ad..c302b39 100644 (file)
@@ -209,6 +209,7 @@ static inline void nft_data_copy(u32 *dst, const struct nft_data *src,
  *     @family: protocol family
  *     @level: depth of the chains
  *     @report: notify via unicast netlink message
+ *     @reg_inited: bitmap of initialised registers
  */
 struct nft_ctx {
        struct net                      *net;
@@ -313,6 +314,7 @@ static inline void *nft_elem_priv_cast(const struct nft_elem_priv *priv)
 /**
  * enum nft_iter_type - nftables set iterator type
  *
+ * @NFT_ITER_UNSPEC: unspecified, to catch errors
  * @NFT_ITER_READ: read-only iteration over set elements
  * @NFT_ITER_UPDATE: iteration under mutex to update set element state
  */
index faa108b..5adf6fd 100644 (file)
@@ -36,6 +36,7 @@ __be32 nf_tproxy_laddr4(struct sk_buff *skb, __be32 user_laddr, __be32 daddr);
 
 /**
  * nf_tproxy_handle_time_wait4 - handle IPv4 TCP TIME_WAIT reopen redirections
+ * @net:       The network namespace.
  * @skb:       The skb being processed.
  * @laddr:     IPv4 address to redirect to or zero.
  * @lport:     TCP port to redirect to or zero.