lkml.org 
[lkml]   [2022]   [Sep]   [26]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] overflow: Fix kern-doc markup for functions
On Mon, Sep 26, 2022 at 12:47:13PM -0700, Kees Cook wrote:
> -/** check_add_overflow() - Calculate addition with overflow checking
> +/**
> + * check_add_overflow - Calculate addition with overflow checking
> *
> * @a: first addend
> * @b: second addend

Why did you remove the ()? And why didn't you delete the blank line?
According to our documentation, the canonical form is:

/**
* function_name() - Brief description of function.
* @arg1: Describe the first argument.
* @arg2: Describe the second argument.
* One can provide multiple line descriptions
* for arguments.

I don't usually complain about people getting that wrong, but when
people correct it to be wrong ...

\
 
 \ /
  Last update: 2022-09-26 23:07    [W:0.323 / U:0.312 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site