lkml.org 
[lkml]   [2020]   [Jul]   [13]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH net-next] net: ipa: fix kerneldoc comments
From
From: Alex Elder <elder@linaro.org>
Date: Mon, 13 Jul 2020 07:24:18 -0500

> This commit affects comments (and in one case, whitespace) only.
>
> Throughout the IPA code, return statements are documented using
> "@Return:", whereas they should use "Return:" instead. Fix these
> mistakes.
>
> In function definitions, some parameters are missing their comment
> to describe them. And in structure definitions, some fields are
> missing their comment to describe them. Add these missing
> descriptions.
>
> Some arguments changed name and type along the way, but their
> descriptions were not updated (an endpoint pointer is now used in
> many places that previously used an endpoint ID). Fix these
> incorrect parameter descriptions.
>
> In the description for the ipa_clock structure, one field had a
> semicolon instead of a colon in its description. Fix this.
>
> Add a missing function description for ipa_gsi_endpoint_data_empty().
>
> All of these issues were identified when building with "W=1".
>
> Signed-off-by: Alex Elder <elder@linaro.org>

Applied, thanks Alex.

\
 
 \ /
  Last update: 2020-07-14 02:12    [W:0.089 / U:0.120 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site