[U-Boot] [PATCH v3 02/13] regmap: Fix documentation

[Mario Six]

Hi Simon,

On Thu, Aug 2, 2018 at 6:56 PM, Simon Glass <sjg at chromium.org> wrote:
> Hi Mario,
>
> On 31 July 2018 at 04:00, Mario Six <mario.six at gdsys.cc> wrote:
>> The documentation in regmap.h is not in kernel-doc format. Correct this.
>>
>> Signed-off-by: Mario Six <mario.six at gdsys.cc>
>> ---
>>
>> v2 -> v3:
>> New in v3
>>
>> ---
>>  include/regmap.h | 48 +++++++++++++++++++++++++++++++++++++++---------
>>  1 file changed, 39 insertions(+), 9 deletions(-)
>
> Do we have a checker for this?
>

Now that the documentation migration is merged, we have one: "kernel-doc -v
-none [file]" will analyze the documentation in a source file and print
warnings and errors if it finds something wrong.

But beware that the checks are not perfect; I found, e.g., that it has problems
with function declarations of the form "func(void)", where it complains
erroneously. Also, it doesn't complain about missing documentation, which would
be a nice feature to have (at least have it activatable via command line
switch).

I'd fix the tool, but my Perl knowledge is non-existent, so I can't really do
it.

> Reviewed-by: Simon Glass <sjg at chromium.org>
>
> Regards,
> Simon

Best regards,
Mario