From 016c39c3b24e390f4672e3a2a649230acab0afd3 Mon Sep 17 00:00:00 2001
From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Wed, 18 Sep 2024 23:49:40 +0200
Subject: [PATCH] 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>
---
include/getopt.h | 3 ---
1 file changed, 3 deletions(-)
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: */
};
};
--
2.39.5