On Wed, Apr 8, 2020 at 1:39 PM Lothar Rubusch <l.rubusch@xxxxxxxxx> wrote: > > Hello, > > (...) > > > > > @@ -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? > > > > > > > You mean the warning "Excess function parameter 'suites' description > > > in 'kunit_test_suites'"? > > > > Yep, I just tried it out locally and it should work. > > Something like '@...:' should be possible, to list the variadic under > "Parameters", and display the corresponding description. That'll probably work, or you can change the `...` to something like `suites_param...` and change the corresponding `__VA_ARGS__` to `suites_param`. Either way works for me. > For curiosity I went through the kunit docs and fixed some formatting > issues. Great piece of work, thanks for realizing kunit! Thanks! > Last but not least, going through the document, there is a chapter > "API" consisting of a single page with one link to "API". > Is this on purpose? I would suggest to take out this level of > indirection and remove the .rst file, linking API directly. Yeah, it's because we have some other features that we are planning on adding soonish which will have their own pages. > I'll send my proposals in a PATCH v2. Let me know then what you think > after that. Looking forward to them! Cheers
