colin/u-boot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: include/getopt.h: remove comments confusing Sphinx

Browse Source 
The Sphinx documentation build process cannot handle the interspersed
'private:' and 'public:' comments. Remove them.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Heinrich Schuchardt
2024-09-18 23:49:40 +02:00
parent 1a58da9365
commit 016c39c3b2
1 changed files with 0 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
include/getopt.h
View File

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