diff options
author | Jakub Kicinski <kuba@kernel.org> | 2023-08-02 09:18:21 -0700 |
---|---|---|
committer | Jakub Kicinski <kuba@kernel.org> | 2023-08-03 09:54:24 -0700 |
commit | 82e896d992fa631cda1f63239fd47b3ab781ffa6 (patch) | |
tree | eb2846b4d8f4ac98f3aa034fd2da3faf52957bab /drivers/media/v4l2-core | |
parent | e70380650a32e4ccb0bd8a2d7b54e1e4a35b39ba (diff) |
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>
Diffstat (limited to 'drivers/media/v4l2-core')
0 files changed, 0 insertions, 0 deletions