On Mon, Apr 6, 2020 at 2:41 PM Lothar Rubusch <l.rubusch@xxxxxxxxx> wrote:
>
> Fix several sphinx warnings at 'make htmldocs'
> - privately declared members not correctly declared as such
> - 'suits' actually is not a function parameter, change declaration to fix
> warning but keep information in comment
>
> Signed-off-by: Lothar Rubusch <l.rubusch@xxxxxxxxx>
Thanks for taking care of this!
> ---
> include/kunit/test.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/include/kunit/test.h b/include/kunit/test.h
> index 9b0c46a6ca1f..fe4ea388528b 100644
> --- a/include/kunit/test.h
> +++ b/include/kunit/test.h
> @@ -175,7 +175,7 @@ struct kunit_suite {
> void (*exit)(struct kunit *test);
> struct kunit_case *test_cases;
>
> - /* private - internal use only */
> + /* private: internal use only. */
> struct dentry *debugfs;
> char *log;
> };
> @@ -232,7 +232,7 @@ void __kunit_test_suites_exit(struct kunit_suite **suites);
> * kunit_test_suites() - used to register one or more &struct kunit_suite
> * with KUnit.
> *
> - * @suites: a statically allocated list of &struct kunit_suite.
> + * suites - a statically allocated list of &struct kunit_suite.
So, I am pretty sure you can name the variadic arguments and then that
gives you a valid parameter to use with kernel doc. Can you try that
out?
> *
> * Registers @suites with the test framework. See &struct kunit_suite for
Also, if my suggestion ends up not working, you should change this
line to match.
> * more information.
> --
> 2.20.1
>
