Messages in this thread | | | Date | Mon, 26 Sep 2022 22:06:19 +0100 | From | Matthew Wilcox <> | Subject | Re: [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 ...
| |