GLib-2.0 ▶ GLib ▶ test_summarySince 2.62

Sets the summary for a test.

This may be included in test report output, and is useful documentation for anyone reading the source code or modifying a test in future. It must be a single line, and it should summarise what the test checks, and how.

This should be called at the top of a test function.

For example:

static void
test_array_sort (void)
{
  g_test_summary ("Test `my_array_sort()` sorts the array correctly and stably, "
                  "including testing zero length and one-element arrays.");

  // ...
}
Copy

See also GLib.test_bug.