[ Version ( since = "2.62" ) ]
public void summary (string summary)

Set the summary for a test, which describes what the test checks, and how it goes about checking it.


See also: bug

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.

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.");




One or two sentences summarising what the test checks, and how it checks it.

Namespace: GLib.Test
Package: glib-2.0