Clarify: Passing NULL creates an empty suite runner

eschaton · eschaton · commit 72b75c442d38 · 2026-07-01T22:13:39.000-07:00
Clarify that calling `srunner_create(NULL)` will return an empty
suite runner to which suites can be added.
diff --git a/src/check.h.in b/src/check.h.in
@@ -1960,7 +1960,8 @@ CK_DLL_EXP const char *CK_EXPORT tr_tname(TestResult * tr);
  * run with srunner_run_all(). Once finished, the suite runner
  * must be freed with srunner_free().
  *
- * @param s suite to generate a suite runner for, NULL if none
+ * @param s suite to generate a suite runner for, NULL to create
+ *          an empty suite runner
  *
  * @return suite runner for the given suite
  *

Original file line number	Diff line number	Diff line change
`@@ -1960,7 +1960,8 @@ CK_DLL_EXP const char CK_EXPORT tr_tname(TestResult tr);`
`1960`	`1960`	`* run with srunner_run_all(). Once finished, the suite runner`
`1961`	`1961`	`* must be freed with srunner_free().`
`1962`	`1962`	`*`
`1963`		`- * @param s suite to generate a suite runner for, NULL if none`
	`1963`	`+ * @param s suite to generate a suite runner for, NULL to create`
	`1964`	`+ * an empty suite runner`
`1964`	`1965`	`*`
`1965`	`1966`	`* @return suite runner for the given suite`
`1966`	`1967`	`*`