kunit: test.h: fix a bad kernel-doc markup
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Wed, 9 Sep 2020 10:07:49 +0000 (12:07 +0200)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 15 Oct 2020 05:49:48 +0000 (07:49 +0200)
As warned by:

./include/kunit/test.h:504: WARNING: Block quote ends without a blank line; unexpected unindent.

The right way to describe a function is:

name - description

Instead, kunit_remove_resource was using:

name: description

Causing it to be improperly parsed.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
include/kunit/test.h

index dba5867c26212391be978646a8c9ebf6a9254398..037de35ae0ffa008891ada80e63811cd9bc07aa9 100644 (file)
@@ -503,8 +503,8 @@ static inline int kunit_destroy_named_resource(struct kunit *test,
 }
 
 /**
- * kunit_remove_resource: remove resource from resource list associated with
- *                       test.
+ * kunit_remove_resource() - remove resource from resource list associated with
+ *                          test.
  * @test: The test context object.
  * @res: The resource to be removed.
  *