From: Matthias Clasen Date: Fri, 11 Jan 2008 16:44:15 +0000 (+0000) Subject: hook up testutils docs X-Git-Tag: GLIB_2_15_2~14 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2cc67d528ea9eb7308859e36b5eca6d88a6f1e5b;p=platform%2Fupstream%2Fglib.git hook up testutils docs svn path=/trunk/; revision=6296 --- diff --git a/ChangeLog b/ChangeLog index b9c0e9f..1f099d4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2008-01-11 Matthias Clasen + + * glib/gtestutils.c: Fix a docs typo + 2008-01-11 12:55:19 Tim Janik * tests/testingbase64.c: added g_base64_encode()/g_base64_decode() diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index a96f6db..8243212 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,7 @@ +2008-01-11 Matthias Clasen + + * glib/*: Hook up gtestutils docs. + 2008-01-08 Alexander Larsson * gio/gio-docs.xml: diff --git a/docs/reference/glib/glib-docs.sgml b/docs/reference/glib/glib-docs.sgml index 4338926..38369cb 100644 --- a/docs/reference/glib/glib-docs.sgml +++ b/docs/reference/glib/glib-docs.sgml @@ -65,6 +65,7 @@ + @@ -162,6 +163,7 @@ synchronize their operation. &glib-Markup; &glib-Keyfile; &glib-Bookmarkfile; + &glib-Testing; &glib-Windows-Compatibility-Functions; diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt index b0946ff..6caa8b6 100644 --- a/docs/reference/glib/glib-sections.txt +++ b/docs/reference/glib/glib-sections.txt @@ -849,10 +849,9 @@ g_return_if_fail g_return_val_if_fail g_return_if_reached g_return_val_if_reached - - -g_assert -g_assert_not_reached +g_warn_if_fail +g_warn_if_reached +g_warn_message g_on_error_query @@ -2542,3 +2541,89 @@ g_checksum_get_digest g_compute_checksum_for_data g_compute_checksum_for_string + +
+Testing +testing +GTestCase +GTestSuite +g_test_minimized_result +g_test_maximized_result +g_test_init +g_test_quick +g_test_slow +g_test_thorough +g_test_perf +g_test_verbose +g_test_quiet +g_test_run +g_test_add_func +g_test_add_data_func +g_test_add + +g_test_message +g_test_bug_base +g_test_bug + +g_test_timer_start +g_test_timer_elapsed +g_test_timer_last + +g_test_queue_free +g_test_queue_destroy +g_test_queue_unref + +GTestTrapFlags +g_test_trap_fork +g_test_trap_has_passed +g_test_trap_reached_timeout +g_test_trap_assert_passed +g_test_trap_assert_failed +g_test_trap_assert_stdout +g_test_trap_assert_stdout_unmatched +g_test_trap_assert_stderr +g_test_trap_assert_stderr_unmatched + +g_test_rand_bit +g_test_rand_int +g_test_rand_int_range +g_test_rand_double +g_test_rand_double_range + +g_assert +g_assert_not_reached +g_assert_cmpstr +g_assert_cmpint +g_assert_cmpuint +g_assert_cmphex +g_assert_cmpfloat +g_strcmp0 + + +g_test_create_case +g_test_create_suite +g_test_get_root +g_test_suite_add +g_test_suite_add_suite +g_test_run_suite + +g_test_trap_assertions +g_assertion_message +g_assertion_message_expr +g_assertion_message_cmpstr +g_assertion_message_cmpnum + +g_test_add_vtable +GTestConfig +g_test_config_vars +GTestLogType +GTestLogMsg +GTestLogBuffer + +g_test_log_type_name +g_test_log_buffer_new +g_test_log_buffer_free +g_test_log_buffer_push +g_test_log_buffer_pop +g_test_log_msg_free +
diff --git a/docs/reference/glib/tmpl/glib-unused.sgml b/docs/reference/glib/tmpl/glib-unused.sgml index caf6330..fe2e351 100644 --- a/docs/reference/glib/tmpl/glib-unused.sgml +++ b/docs/reference/glib/tmpl/glib-unused.sgml @@ -48,6 +48,30 @@ Desktop Entry Parser + + + + + + + + + + + + + + + + + + + + + +Testing + + @@ -653,6 +677,14 @@ in any UNIX manual. @error: @Returns: + + + + + +@size: +@Returns: + diff --git a/docs/reference/glib/tmpl/i18n.sgml b/docs/reference/glib/tmpl/i18n.sgml index 9076edb..7c2226c 100644 --- a/docs/reference/glib/tmpl/i18n.sgml +++ b/docs/reference/glib/tmpl/i18n.sgml @@ -82,13 +82,10 @@ pass to xgettext when extracting messages. Note that this only works with GNU gettext >= 0.15. -@Context: -@String: +@Context: a message context, must be a string literal +@String: a message id, must be a string literal @Returns: the translated message @Since: 2.16 - -@msgctxt: a message context, must be a string literal -@msgid: a message id, must be a string literal diff --git a/docs/reference/glib/tmpl/spawn.sgml b/docs/reference/glib/tmpl/spawn.sgml index c744cee..d3c1bd8 100644 --- a/docs/reference/glib/tmpl/spawn.sgml +++ b/docs/reference/glib/tmpl/spawn.sgml @@ -89,7 +89,11 @@ function will thus only affect the child, not the parent. Note that POSIX allows only async-signal-safe functions (see signal(7)) to be called in the child between fork() and exec(), which drastically -limits the usefulness of child setup functions. +limits the usefulness of child setup functions. + + + +Also note that modifying the environment from diff --git a/docs/reference/glib/tmpl/threads.sgml b/docs/reference/glib/tmpl/threads.sgml index 0b2eb32..f0c59d0 100644 --- a/docs/reference/glib/tmpl/threads.sgml +++ b/docs/reference/glib/tmpl/threads.sgml @@ -1728,43 +1728,43 @@ get_debug_flags () Function to be called when starting a critical initialization section. -The argument value_location must point to a static 0-initialized variable -that will be set to a value other than 0 at the end of the initialization section. -In combination with g_once_init_leave() and the unique address value_location, +The argument @value_location must point to a static 0-initialized variable +that will be set to a value other than 0 at the end of the initialization +section. +In combination with g_once_init_leave() and the unique address @value_location, it can be ensured that an initialization section will be executed only once during a program's life time, and that concurrent threads are blocked until initialization completed. To be used in constructs like this: - - + static gsize initialization_value = 0; -if (g_once_init_enter (&initialization_value)) // section start +if (g_once_init_enter (&initialization_value)) /* section start */ { - gsize setup_value = 42; // initialization code here - g_once_init_leave (&initialization_value, setup_value); // section end + gsize setup_value = 42; /* initialization code here */ + g_once_init_leave (&initialization_value, setup_value); /* section end */ } -// use initialization_value here - - +/* use initialization_value here */ + @value_location: location of a static initializable variable containing 0. -@Returns: %TRUE if the initialization section should be entered, %FALSE and blocks otheriwse +@Returns: %TRUE if the initialization section should be entered, %FALSE and blocks otherwise @Since: 2.14 -Counterpart to g_once_init_enter(). Expects a location of a static 0-initialized -initialization variable, and an initialization value other than 0. Sets the variable -to the initialization value, and releases concurrent threads blocking in -g_once_init_enter() on this initialization variable. +Counterpart to g_once_init_enter(). Expects a location of a static +0-initialized initialization variable, and an initialization value other +than 0. Sets the variable to the initialization value, and releases +concurrent threads blocking in g_once_init_enter() on this initialization +variable. @value_location: location of a static initializable variable containing 0. -@initialization_value: new non-0 value for *@value_location: +@initialization_value: new non-0 value for *@value_location. @Since: 2.14 diff --git a/docs/reference/glib/tmpl/warnings.sgml b/docs/reference/glib/tmpl/warnings.sgml index 496d7e6..e7f46a7 100644 --- a/docs/reference/glib/tmpl/warnings.sgml +++ b/docs/reference/glib/tmpl/warnings.sgml @@ -134,30 +134,31 @@ Logs a critical message and returns @val. @val: the value to return from the current function. - + -Debugging macro to terminate the application if the assertion fails. -If the assertion fails (i.e. the expression is not true), an error message -is logged and the application is terminated. - - -The macro can be turned off in final releases of code by defining -#G_DISABLE_ASSERT when compiling the application. + -@expr: the expression to check. +@expr: - + -Debugging macro to terminate the application if it is ever reached. -If it is reached, an error message is logged and the application is terminated. + + + + + -The macro can be turned off in final releases of code by defining -#G_DISABLE_ASSERT when compiling the application. + +@domain: +@file: +@line: +@func: +@warnexpr: diff --git a/glib/gtestutils.c b/glib/gtestutils.c index 7dfba17..bdf3642 100644 --- a/glib/gtestutils.c +++ b/glib/gtestutils.c @@ -734,7 +734,8 @@ g_test_get_root (void) * Runs all tests under the toplevel suite which can be retrieved * with g_test_get_root(). Similar to g_test_run_suite(), the test * cases to be run are filtered according to - * test path arguments (-p ) as parsed by g_test_init(). + * test path arguments (-p testpath) as + * parsed by g_test_init(). * g_test_run_suite() or g_test_run() may only be called once * in a program. *