diff options
| author | Sven Eckelmann <sven@narfation.org> | 2026-06-08 09:56:29 +0200 |
|---|---|---|
| committer | Sven Eckelmann <sven@narfation.org> | 2026-08-04 17:33:04 +0200 |
| commit | 3ebcaccc8871ba723ea336db9da9084ae3cffcb3 (patch) | |
| tree | 35fd80eb43d53a8e7201de51fe0ad63391823af9 /include/uapi | |
| parent | e558ee008810ca24bc85747779673f5aa82ffddb (diff) | |
| download | linux-3ebcaccc8871ba723ea336db9da9084ae3cffcb3.tar.gz linux-3ebcaccc8871ba723ea336db9da9084ae3cffcb3.zip | |
batman-adv: add missing kernel-doc comments
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>
Diffstat (limited to 'include/uapi')
| -rw-r--r-- | include/uapi/linux/batadv_packet.h | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/include/uapi/linux/batadv_packet.h b/include/uapi/linux/batadv_packet.h index 1241285b866c..32436560ecc8 100644 --- a/include/uapi/linux/batadv_packet.h +++ b/include/uapi/linux/batadv_packet.h @@ -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; }; /** |