diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-08-27 08:31:43 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-10-15 07:49:48 +0200 |
| commit | 38d9b909f90e715c4b5d572e4e9c914a10931094 (patch) | |
| tree | b8b3d56a35c162f34b61f26de128d585963d47fd /include/kunit | |
| parent | 5b874af627004ac3660c96cb1bcfaefb7c9e7130 (diff) | |
| download | lwn-38d9b909f90e715c4b5d572e4e9c914a10931094.tar.gz lwn-38d9b909f90e715c4b5d572e4e9c914a10931094.zip | |
kunit: test.h: solve kernel-doc warnings
There are some warnings there:
./include/kunit/test.h:90: warning: Function parameter or member 'name' not described in 'kunit_resource'
./include/kunit/test.h:353: warning: Function parameter or member 'res' not described in 'kunit_add_resource'
./include/kunit/test.h:367: warning: Function parameter or member 'res' not described in 'kunit_add_named_resource'
./include/kunit/test.h:367: warning: Function parameter or member 'name' not described in 'kunit_add_named_resource'
./include/kunit/test.h:367: warning: Function parameter or member 'data' not described in 'kunit_add_named_resource'
./include/kunit/test.h:367: warning: Excess function parameter 'name_data' description in 'kunit_add_named_resource'
Address them, ensuring that all non-private arguments will
be properly described. With that regards, at struct kunit_resource,
the free argument is described as user-provided. So, this
doesn't seem to belong to the "private" part of the struct.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Diffstat (limited to 'include/kunit')
| -rw-r--r-- | include/kunit/test.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/include/kunit/test.h b/include/kunit/test.h index 3391f38389f8..dba5867c2621 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -25,6 +25,7 @@ typedef void (*kunit_resource_free_t)(struct kunit_resource *); /** * struct kunit_resource - represents a *test managed resource* * @data: for the user to store arbitrary data. + * @name: optional name * @free: a user supplied function to free the resource. Populated by * kunit_resource_alloc(). * @@ -80,10 +81,10 @@ typedef void (*kunit_resource_free_t)(struct kunit_resource *); */ struct kunit_resource { void *data; - const char *name; /* optional name */ + const char *name; + kunit_resource_free_t free; /* private: internal use only. */ - kunit_resource_free_t free; struct kref refcount; struct list_head node; }; @@ -348,6 +349,7 @@ static inline void kunit_put_resource(struct kunit_resource *res) * none is supplied, the resource data value is simply set to @data. * If an init function is supplied, @data is passed to it instead. * @free: a user-supplied function to free the resource (if needed). + * @res: The resource. * @data: value to pass to init function or set in resource data field. */ int kunit_add_resource(struct kunit *test, @@ -361,7 +363,9 @@ int kunit_add_resource(struct kunit *test, * @test: The test context object. * @init: a user-supplied function to initialize the resource data, if needed. * @free: a user-supplied function to free the resource data, if needed. - * @name_data: name and data to be set for resource. + * @res: The resource. + * @name: name to be set for resource. + * @data: value to pass to init function or set in resource data field. */ int kunit_add_named_resource(struct kunit *test, kunit_resource_init_t init, |