]> git.baikalelectronics.ru Git - kernel.git/commit
net: ipa: fix kerneldoc comments
authorAlex Elder <elder@linaro.org>
Mon, 13 Jul 2020 12:24:18 +0000 (07:24 -0500)
committerDavid S. Miller <davem@davemloft.net>
Tue, 14 Jul 2020 00:11:53 +0000 (17:11 -0700)
commit511e03e45bdb1fe77deaef0f0e6dc5d5597d2209
treedf7de634f9439aed143cfe506270eb701fcdad06
parent503ae4e33d92e15598f7811be193cf3ee9e84839
net: ipa: fix kerneldoc comments

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>
Signed-off-by: David S. Miller <davem@davemloft.net>
16 files changed:
drivers/net/ipa/gsi.c
drivers/net/ipa/gsi.h
drivers/net/ipa/gsi_private.h
drivers/net/ipa/gsi_trans.h
drivers/net/ipa/ipa_clock.c
drivers/net/ipa/ipa_clock.h
drivers/net/ipa/ipa_cmd.h
drivers/net/ipa/ipa_endpoint.c
drivers/net/ipa/ipa_gsi.h
drivers/net/ipa/ipa_interrupt.h
drivers/net/ipa/ipa_main.c
drivers/net/ipa/ipa_mem.c
drivers/net/ipa/ipa_smp2p.h
drivers/net/ipa/ipa_table.c
drivers/net/ipa/ipa_table.h
drivers/net/ipa/ipa_uc.c