rxrpc: kdoc: Update function descriptions and add link from rxrpc.rst
authorDavid Howells <dhowells@redhat.com>
Fri, 11 Apr 2025 09:52:46 +0000 (10:52 +0100)
committerJakub Kicinski <kuba@kernel.org>
Tue, 15 Apr 2025 00:36:40 +0000 (17:36 -0700)
commit28a79fc9b03e4ed89b65e5300091e7ed55e13192
tree95ec43889e8c08df115ea8906ca75c56e4cb4b1b
parenta4cba7e98e35e618b3b4e1fce9746caad67cb308
rxrpc: kdoc: Update function descriptions and add link from rxrpc.rst

Update the kerneldoc function descriptions to add "Return:" sections for
AF_RXRPC exported functions that have return values to stop the kdoc
builder from throwing warnings.

Also add links from the rxrpc.rst API doc to add a function API reference
at the end.  (Note that the API doc really needs updating, but that's
beyond this patchset).

Signed-off-by: David Howells <dhowells@redhat.com>
cc: Marc Dionne <marc.dionne@auristor.com>
cc: Simon Horman <horms@kernel.org>
cc: linux-afs@lists.infradead.org
Link: https://patch.msgid.link/20250411095303.2316168-2-dhowells@redhat.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Documentation/networking/rxrpc.rst
net/rxrpc/af_rxrpc.c
net/rxrpc/key.c
net/rxrpc/peer_object.c
net/rxrpc/recvmsg.c
net/rxrpc/sendmsg.c
net/rxrpc/server_key.c