milos-linux/tools/lib/python/kdoc
Mauro Carvalho Chehab cd77a9aa20 docs: kdoc: use tokenizer to handle comments on structs
Better handle comments inside structs. After those changes,
all unittests now pass:

  test_private:
    TestPublicPrivate:
        test balanced_inner_private:                                 OK
        test balanced_non_greddy_private:                            OK
        test balanced_private:                                       OK
        test no private:                                             OK
        test unbalanced_inner_private:                               OK
        test unbalanced_private:                                     OK
        test unbalanced_struct_group_tagged_with_private:            OK
        test unbalanced_two_struct_group_tagged_first_with_private:  OK
        test unbalanced_without_end_of_line:                         OK

  Ran 9 tests

This also solves a bug when handling STRUCT_GROUP() with a private
comment on it:

	@@ -397134,7 +397134,7 @@ basic V4L2 device-level support.
	             unsigned int    max_len;
	             unsigned int    offset;
	             struct page_pool_params_slow  slow;
	-            STRUCT_GROUP( struct net_device *netdev;
	+            struct net_device *netdev;
	             unsigned int queue_idx;
	             unsigned int    flags;
	       };

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Message-ID: <f83ee9e8c38407eaab6ad10d4ccf155fb36683cc.1773074166.git.mchehab+huawei@kernel.org>
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <054763260f7b5459ad0738ed906d7c358d640692.1773770483.git.mchehab+huawei@kernel.org>
2026-03-22 15:02:29 -06:00
..
__init__.py
c_lex.py docs: add a C tokenizer to be used by kernel-doc 2026-03-22 15:02:29 -06:00
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: use tokenizer to handle comments on structs 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