From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Wed, 18 Sep 2024 21:49:40 +0000 (+0200)
Subject: doc: include/getopt.h: remove comments confusing Sphinx
X-Git-Url: http://git.dujemihanovic.xyz/%7B%7B%20%24style.Permalink%20%7D%7D?a=commitdiff_plain;h=016c39c3b24e390f4672e3a2a649230acab0afd3;p=u-boot.git

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

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

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---

diff --git a/include/getopt.h b/include/getopt.h
index 8645082da2..0cf7ee84d6 100644
--- a/include/getopt.h
+++ b/include/getopt.h
@@ -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: */
 	};
 };