diff options
author | Jakub Kicinski <kuba@kernel.org> | 2020-12-01 15:38:46 -0800 |
---|---|---|
committer | Jakub Kicinski <kuba@kernel.org> | 2020-12-01 15:38:46 -0800 |
commit | f7cf335c7d008543539708e8051d27c4265fa103 (patch) | |
tree | 328569a32fe40c3757dfe47f5a5f7064f67a71c1 /net/tipc/discover.c | |
parent | 7fe2af16e6a18e0e5a34a139f2b2e38106d67e07 (diff) | |
parent | 2fc30decf730832f05a07fae710869c3577a36a8 (diff) |
Merge branch 'net-tipc-fix-all-kernel-doc-and-add-tipc-networking-chapter'
Randy Dunlap says:
====================
net/tipc: fix all kernel-doc and add TIPC networking chapter
Fix lots of net/tipc/ kernel-doc warnings. Add many struct field and
function parameter descriptions.
Then add a TIPC chapter to the networking documentation book.
All patches have been rebased to current net-next.
Note: some of the struct members and function parameters are marked
with "FIXME". They could use some additional descriptions if
someone could help add to them. Thanks.
====================
Link: https://lore.kernel.org/r/20201129183251.7049-1-rdunlap@infradead.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Diffstat (limited to 'net/tipc/discover.c')
-rw-r--r-- | net/tipc/discover.c | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/net/tipc/discover.c b/net/tipc/discover.c index d4ecacddb40c..5380f605b851 100644 --- a/net/tipc/discover.c +++ b/net/tipc/discover.c @@ -74,6 +74,7 @@ struct tipc_discoverer { /** * tipc_disc_init_msg - initialize a link setup message * @net: the applicable net namespace + * @skb: buffer containing message * @mtyp: message type (request or response) * @b: ptr to bearer issuing message */ @@ -341,7 +342,7 @@ exit: * @dest: destination address for request messages * @skb: pointer to created frame * - * Returns 0 if successful, otherwise -errno. + * Return: 0 if successful, otherwise -errno. */ int tipc_disc_create(struct net *net, struct tipc_bearer *b, struct tipc_media_addr *dest, struct sk_buff **skb) @@ -380,7 +381,7 @@ int tipc_disc_create(struct net *net, struct tipc_bearer *b, /** * tipc_disc_delete - destroy object sending periodic link setup requests - * @d: ptr to link duest structure + * @d: ptr to link dest structure */ void tipc_disc_delete(struct tipc_discoverer *d) { |