]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
doc: include/getopt.h: remove comments confusing Sphinx
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Wed, 18 Sep 2024 21:49:40 +0000 (23:49 +0200)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Sat, 21 Sep 2024 08:58:38 +0000 (10:58 +0200)
The Sphinx documentation build process cannot handle the interspersed
'private:' and 'public:' comments. Remove them.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
include/getopt.h

index 8645082da2a7ab822c9fc7886996e0fe5e09f143..0cf7ee84d6f6ca8751de47bf1cedee33ec87f1a6 100644 (file)
@@ -20,11 +20,9 @@ struct getopt_state {
         * parsed all of @argv, then @index will equal @argc.
         */
        int index;
-       /* private: */
        /** @arg_index: Index within the current argument */
        int arg_index;
        union {
-               /* public: */
                /**
                 * @opt: Option being parsed when an error occurs. @opt is only
                 * valid when getopt() returns ``?`` or ``:``.
@@ -35,7 +33,6 @@ struct getopt_state {
                 * is only valid when getopt() returns an option character.
                 */
                char *arg;
-       /* private: */
        };
 };