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.
Showing the changes to include/uapi (1 of 17 files). Show all
Unified · Split
| @@ -192,13 +192,19 @@ enum batadv_tvlv_type { · 191 unmodified lines | ||
| 192 | 192 | }; |
| 193 | 193 | |
| 194 | 194 | #pragma pack(2) |
| 195 | −/* the destination hardware field in the ARP frame is used to | |
| 196 | − * transport the claim type and the group id | |
| 195 | +/** | |
| 196 | + * struct batadv_bla_claim_dst - layout of the destination MAC of a BLA claim | |
| 197 | + * frame | |
| 198 | + * @magic: fixed magic prefix (FF:43:05) identifying claim frames | |
| 199 | + * @type: claim frame type, see &enum batadv_bla_claimframe | |
| 200 | + * @group: group identifier of the announcing backbone gateway | |
| 201 | + * | |
| 202 | + * used in the destination hardware field of the ARP frame | |
| 197 | 203 | */ |
| 198 | 204 | struct batadv_bla_claim_dst { |
| 199 | − __u8 magic[3]; /* FF:43:05 */ | |
| 200 | − __u8 type; /* bla_claimframe */ | |
| 201 | − __be16 group; /* group id */ | |
| 205 | + __u8 magic[3]; | |
| 206 | + __u8 type; | |
| 207 | + __be16 group; | |
| 202 | 208 | }; |
| 203 | 209 | |
| 204 | 210 | /** |