Re: [PATCH 4/6] scripts: kernel-doc: support in-line comments on nested structs/unions

[Mauro Carvalho Chehab]

Em Fri, 16 Feb 2018 15:52:33 +0100
Markus Heiser <markus.heiser@xxxxxxxxxxx> escreveu:

> > Am 16.02.2018 um 14:48 schrieb Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>:
> > 
> > The parser at kernel-doc rejects names with dots in the middle.
> > Fix it, in order to support nested structs/unions.
> > 
> > Tested-by: Jani Nikula <jani.nikula@xxxxxxxxx>
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
> > ---
> > scripts/kernel-doc | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> > index fee8952037b1..06d7f3f2c094 100755
> > --- a/scripts/kernel-doc
> > +++ b/scripts/kernel-doc
> > @@ -363,7 +363,7 @@ my $doc_sect = $doc_com .
> > my $doc_content = $doc_com_body . '(.*)';
> > my $doc_block = $doc_com . 'DOC:\s*(.*)?';
> > my $doc_inline_start = '^\s*/\*\*\s*$';
> > -my $doc_inline_sect = '\s*\*\s*(@[\w\s]+):(.*)';
> > +my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';  
> 
> Thanks!
> 
> FWIW: added similar patch to python variant of kernel-doc:
> 
> https://github.com/return42/linuxdoc/commit/5c5da9a
> 
> rendered example:
> 
>   https://return42.github.io/linuxdoc/linuxdoc-howto/all-in-a-tumble.html#struct-my-long-struct

On a quick look, on your example, bar2.barbar description looks different
than what we get from the perl version.

There, it generates it as:

``bar2.barbar``
  Description for **barbar** inside **foo.bar2**

Regards,
Mauro