mirrors/linux
2
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2026-09-11 05:43:16 -04:00
Code Issues Packages Projects Releases Wiki Activity

batman-adv: add missing kernel-doc comments

Browse Source 
batman-adv requires kernel-doc for all functions and data types visible
outside their own translation unit. Promoting a function from static to
module-wide visibility currently requires adding documentation from
scratch. However, this burden falls on whoever promotes a function from
static to module-wide visibility, rather than its original implementer.

Add the missing kernel-doc comments for the remaining undocumented
functions and data types to reduce the complexity for new contributions.

Signed-off-by: Sven Eckelmann <sven@narfation.org>
This commit is contained in:
Sven Eckelmann
2026-06-08 09:56:29 +02:00
parent e558ee0088
commit 3ebcaccc88
17 changed files with 711 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
include/uapi/linux/batadv_packet.h
View File

@@ -192,13 +192,19 @@ enum batadv_tvlv_type {
};
#pragma pack(2)
/* the destination hardware field in the ARP frame is used to
* transport the claim type and the group id
/**
* struct batadv_bla_claim_dst - layout of the destination MAC of a BLA claim
* frame
* @magic: fixed magic prefix (FF:43:05) identifying claim frames
* @type: claim frame type, see &enum batadv_bla_claimframe
* @group: group identifier of the announcing backbone gateway
*
* used in the destination hardware field of the ARP frame
*/
struct batadv_bla_claim_dst {
__u8 magic[3]; /* FF:43:05 */
__u8 type; /* bla_claimframe */
__be16 group; /* group id */
__u8 magic[3];
__u8 type;
__be16 group;
};
/**