[glib] Clarify documentation of fast/slow/thorough and quiet/verbose tests



commit 5cb29d7909afdb41054ca47892aea4e0a79f2d7a
Author: Simon McVittie <simon mcvittie collabora co uk>
Date:   Wed Dec 14 17:32:16 2011 +0000

    Clarify documentation of fast/slow/thorough and quiet/verbose tests
    
    It turns out that there is no middle setting between fast and
    slow/thorough, but there *is* a middle setting between quiet and verbose.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=666116

 glib/gtestutils.c |   15 +++++++++++----
 1 files changed, 11 insertions(+), 4 deletions(-)
---
diff --git a/glib/gtestutils.c b/glib/gtestutils.c
index ddc880a..b7f3223 100644
--- a/glib/gtestutils.c
+++ b/glib/gtestutils.c
@@ -107,6 +107,8 @@
  * g_test_quick:
  *
  * Returns %TRUE if tests are run in quick mode.
+ * Exactly one of g_test_quick() and g_test_slow() is active in any run;
+ * there is no "medium speed".
  *
  * Returns: %TRUE if in quick mode
  */
@@ -115,16 +117,19 @@
  * g_test_slow:
  *
  * Returns %TRUE if tests are run in slow mode.
+ * Exactly one of g_test_quick() and g_test_slow() is active in any run;
+ * there is no "medium speed".
  *
- * Returns: %TRUE if in slow mode
+ * Returns: the opposite of g_test_quick()
  */
 
 /**
  * g_test_thorough:
  *
- * Returns %TRUE if tests are run in thorough mode.
+ * Returns %TRUE if tests are run in thorough mode, equivalent to
+ * g_test_slow().
  *
- * Returns: %TRUE if in thorough mode
+ * Returns: the same thing as g_test_slow()
  */
 
 /**
@@ -139,6 +144,7 @@
  * g_test_verbose:
  *
  * Returns %TRUE if tests are run in verbose mode.
+ * The default is neither g_test_verbose() nor g_test_quiet().
  *
  * Returns: %TRUE if in verbose mode
  */
@@ -147,8 +153,9 @@
  * g_test_quiet:
  *
  * Returns %TRUE if tests are run in quiet mode.
+ * The default is neither g_test_verbose() nor g_test_quiet().
  *
- * Returns: %TRUE if in quied mode
+ * Returns: %TRUE if in quiet mode
  */
 
 /**



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