On 8/2/23 09:18, Jakub Kicinski wrote: > All struct members of the driver-facing APIs are documented twice, > in the code and under Documentation. This is a bit tedious. > so easier to maintain... > 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. Ack that. > > Using kdoc also gives us links (mentioning a function or struct > in the text gets replaced by a link to its doc). > > Signed-off-by: Jakub Kicinski <kuba@xxxxxxxxxx> Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> Thanks. > -- > CC: hawk@xxxxxxxxxx > CC: ilias.apalodimas@xxxxxxxxxx > CC: corbet@xxxxxxx > CC: linux-doc@xxxxxxxxxxxxxxx > CC: Lorenzo Bianconi <lorenzo@xxxxxxxxxx> > CC: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> > CC: Alexander Lobakin <aleksander.lobakin@xxxxxxxxx> > --- > Documentation/networking/page_pool.rst | 86 ++++------------ > include/net/page_pool.h | 134 +++++++++++++++++++------ > net/core/page_pool.c | 31 +++++- > 3 files changed, 152 insertions(+), 99 deletions(-) > -- ~Randy
