Commit e27cb89a authored by Jakub Kicinski's avatar Jakub Kicinski Committed by Jonathan Corbet
Browse files

scripts: kernel-doc: support private / public marking for enums 



Enums benefit from private markings, too. For netlink attribute
name enums always end with a pair of __$n_MAX and $n_MAX members.
Documenting them feels a bit tedious.

Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Message-ID: <20230621223525.2722703-1-kuba@kernel.org>
parent 1e6115f5

scripts/kernel-doc

+3 −0
Original line number Diff line number Diff line
@@ -1301,6 +1301,9 @@ sub dump_enum($$) { 
    my $file = shift;

    my $members;



    # ignore members marked private:

    $x =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;

    $x =~ s/\/\*\s*private:.*}/}/gosi;



    $x =~ s@/\*.*?\*/@@gos;	# strip comments.

    # strip #define macros inside enums