[glib: 1/2] docs: Add example to g_test_summary() documentation



commit 4b087717a0f57e964008ee998ce20f41338d0c21
Author: Philip Withnall <withnall endlessm com>
Date:   Mon Jul 15 11:07:38 2019 +0100

    docs: Add example to g_test_summary() documentation
    
    Signed-off-by: Philip Withnall <withnall endlessm com>

 glib/gtestutils.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)
---
diff --git a/glib/gtestutils.c b/glib/gtestutils.c
index ecef563b7..517c03b53 100644
--- a/glib/gtestutils.c
+++ b/glib/gtestutils.c
@@ -1941,6 +1941,18 @@ g_test_bug (const char *bug_uri_snippet)
  *
  * This should be called at the top of a test function.
  *
+ * For example:
+ * |[<!-- language="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.");
+ *
+ *   …
+ * }
+ * ]|
+ *
  * Since: 2.62
  * See also: g_test_bug()
  */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]