Skip to content

Fix incorrect tr_* function documentation. (#369) #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eschaton merged 2 commits into from
Jul 2, 2026
+16 −17
Merged

Fix incorrect tr_* function documentation. (#369) #375

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a43909b
Fix incorrect tr_* function documentation. (#369)
eschaton Jun 30, 2026
72b75c4
Clarify: Passing NULL creates an empty suite runner
eschaton Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 16 additions & 17 deletions src/check.h.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1903,7 +1903,7 @@ CK_DLL_EXP enum test_result CK_EXPORT tr_rtype(TestResult * tr);
CK_DLL_EXP enum ck_result_ctx CK_EXPORT tr_ctx(TestResult * tr);

/**
* Retrieve failure message from test result, if applicable.
* Retrieve the message from a test result.
*
* @return pointer to a message, if one exists. NULL otherwise.
*
Expand All @@ -1912,43 +1912,41 @@ CK_DLL_EXP enum ck_result_ctx CK_EXPORT tr_ctx(TestResult * tr);
CK_DLL_EXP const char *CK_EXPORT tr_msg(TestResult * tr);

/**
* Retrieve line number at which a failure occurred, if applicable.
* Retrieve a line number from a test result.
*
* @return If the test resulted in a failure, returns the line number
* that the failure occurred on; otherwise returns -1.
* @return If a test resulted in a failure, returns the line number
* that the failure occurred on. Otherwise returns the line
* number of the last assertion in the test.
*
* @since 0.6.0
*/
CK_DLL_EXP int CK_EXPORT tr_lno(TestResult * tr);

/**
* Retrieve file name at which a failure occurred, if applicable.
* Retrieve test file name from a TestResult.
*
* @return If the test resulted in a failure, returns a string
* containing the name of the file where the failure
* occurred; otherwise returns NULL.
* @return A string containing the name of the file containing the
* test associated with the result.
*
* @since 0.6.0
*/
CK_DLL_EXP const char *CK_EXPORT tr_lfile(TestResult * tr);

/**
* Retrieve test case name in which a failure occurred, if applicable.
* Retrieve test case name from a TestResult.
*
* @return If the test resulted in a failure, returns a string
* containing the name of the test suite where the failure
* occurred; otherwise returns NULL.
* @return A string containing the name of the test case associated
* with the result.
*
* @since 0.6.0
*/
CK_DLL_EXP const char *CK_EXPORT tr_tcname(TestResult * tr);

/**
* Retrieve test name in which a failure occurred, if applicable.
* Retrieve test name from a TestResult.
*
* @return If the test resulted in a failure, returns a string
* containing the name of the test where the failure
* occurred; otherwise returns NULL.
* @return A string containing the name of the test associated with
* the result.
*
* @since 0.15.3
*/
Expand All @@ -1962,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
* @param s suite to generate a suite runner for, NULL to create
* an empty suite runner
*
* @return suite runner for the given suite
*
Expand Down
Loading