kunit: test: fix remaining kernel-doc warnings
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Wed, 21 Oct 2020 12:17:26 +0000 (14:17 +0200)
committerShuah Khan <skhan@linuxfoundation.org>
Mon, 26 Oct 2020 19:23:44 +0000 (13:23 -0600)
commit7f32b10c6b461a369b9741623cd3f722134066f0
tree762d6e0ea3759aa5e15f3457586a3163330729fa
parent3fc48259d5250f7a3ee021ad0492b604c428c564
kunit: test: fix remaining kernel-doc warnings

test.h still produce three warnings:

include/kunit/test.h:282: warning: Function parameter or member '__suites' not described in 'kunit_test_suites_for_module'
include/kunit/test.h:282: warning: Excess function parameter 'suites_list' description in 'kunit_test_suites_for_module'
include/kunit/test.h:314: warning: Excess function parameter 'suites' description in 'kunit_test_suites'

They're all due to errors at kernel-doc markups. Update them.

It should be noticed that this patch moved a kernel-doc
markup that were located at the wrong place, and using a wrong
name. Kernel-doc only supports kaving the markup just before the
function/macro declaration. Placing it elsewhere will make it do
wrong assumptions.

Fixes: aac35468ca20 ("kunit: test: create a single centralized executor for all tests")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Tested-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
include/kunit/test.h