diff mbox series

Documentation: test.h - fix warnings

Message ID 20200406214130.21224-1-l.rubusch@gmail.com
State New
Headers show
Series Documentation: test.h - fix warnings | expand

Commit Message

Lothar Rubusch April 6, 2020, 9:41 p.m. UTC 
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@gmail.com>
---
 include/kunit/test.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff mbox series

Patch

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.
  *
  * Registers @suites with the test framework. See &struct kunit_suite for
  * more information.