summary


Description:

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

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:

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

// ... } ```

See also [func@GLib.test_bug].

Parameters:

summary

summary of the test purpose


Namespace: GLib.Test
Package: glib-2.0