docs: net: page_pool: use kdoc to avoid duplicating the information
authorJakub Kicinski <kuba@kernel.org>
Wed, 2 Aug 2023 16:18:21 +0000 (09:18 -0700)
committerJakub Kicinski <kuba@kernel.org>
Thu, 3 Aug 2023 16:54:24 +0000 (09:54 -0700)
commit82e896d992fa631cda1f63239fd47b3ab781ffa6
treeeb2846b4d8f4ac98f3aa034fd2da3faf52957bab
parente70380650a32e4ccb0bd8a2d7b54e1e4a35b39ba
docs: net: page_pool: use kdoc to avoid duplicating the information

All struct members of the driver-facing APIs are documented twice,
in the code and under Documentation. This is a bit tedious.

I also get the feeling that a lot of developers will read the header
when coding, rather than the doc. Bring the two a little closer
together by using kdoc for structs and functions.

Using kdoc also gives us links (mentioning a function or struct
in the text gets replaced by a link to its doc).

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Jesper Dangaard Brouer <hawk@kernel.org>
Link: https://lore.kernel.org/r/20230802161821.3621985-3-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Documentation/networking/page_pool.rst
include/net/page_pool.h
net/core/page_pool.c