milos-linux/tools/lib/python/kdoc
Mauro Carvalho Chehab b1e64e30fc docs: kdoc: don't add broken comments inside prototypes
Parsing a file like drivers/scsi/isci/host.h, which contains
broken kernel-doc markups makes it create a prototype that contains
unmatched end comments.

That causes, for instance, struct sci_power_control to be shown this
this prototype:

    struct sci_power_control {
        * it is not. */ bool timer_started;
        */ struct sci_timer timer;
        * requesters field. */ u8 phys_waiting;
        */ u8 phys_granted_power;
        * mapped into requesters via struct sci_phy.phy_index */ struct isci_phy *requesters[SCI_MAX_PHYS];
    };

as comments won't start with "/*" anymore.

Fix the logic to detect such cases, and keep adding the comments
inside it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Message-ID: <18e577dbbd538dcc22945ff139fe3638344e14f0.1773074166.git.mchehab+huawei@kernel.org>
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <12ac4a97e2bd5a19d6537122c10098690c38d2c7.1773770483.git.mchehab+huawei@kernel.org>
2026-03-22 15:02:29 -06:00
..
__init__.py
enrich_formatter.py docs: kdoc: enrich_formatter: Improve docstrings and comments 2026-01-23 11:37:38 -07:00
kdoc_files.py docs: kdoc_files: document KernelFiles() ABI 2026-03-09 10:23:20 -06:00
kdoc_item.py docs: kdoc_item: Improve docstrings and comments 2026-01-23 11:37:38 -07:00
kdoc_output.py docs: kdoc_output: better handle lists 2026-03-09 10:34:39 -06:00
kdoc_parser.py docs: kdoc: don't add broken comments inside prototypes 2026-03-22 15:02:29 -06:00
kdoc_re.py docs: kdoc_re: make NestedMatch use KernRe 2026-03-03 10:47:25 -07:00
latex_fonts.py docs: kdoc: latex_fonts: Improve docstrings and comments 2026-01-23 11:37:38 -07:00
parse_data_structs.py docs: kdoc: parse_data_structs: Improve docstrings and comments 2026-01-23 11:37:38 -07:00
python_version.py docs: kdoc: python_version: Improve docstrings and comments 2026-01-23 11:37:38 -07:00
xforms_lists.py docs: kdoc_parser: move nested match transforms to xforms_lists.py 2026-03-03 10:47:25 -07:00