Fixed gtk-doc warnings by updating the documentation of various functions.

2008-01-30  Wouter Bolsterlee  <wbolster@svn.gnome.org>

	* glib/gchecksum.c:
	* glib/gtestutils.c:
	* glib/gutils.c:

	Fixed gtk-doc warnings by updating the documentation of
	various functions.

svn path=/trunk/; revision=6429
This commit is contained in:
Wouter Bolsterlee 2008-01-30 20:52:13 +00:00 committed by Wouter Bolsterlee
parent b80cb2ec04
commit ca25b31ee3
4 changed files with 63 additions and 54 deletions

View File

@ -1,3 +1,12 @@
2008-01-30 Wouter Bolsterlee <wbolster@svn.gnome.org>
* glib/gchecksum.c:
* glib/gtestutils.c:
* glib/gutils.c:
Fixed gtk-doc warnings by updating the documentation of
various functions.
2008-01-29 Christian Persch <chpe@gnome.org> 2008-01-29 Christian Persch <chpe@gnome.org>
* docs/reference/glib/tmpl/macros_misc.sgml: G_GNUC_[PRETTY_]FUNCTION * docs/reference/glib/tmpl/macros_misc.sgml: G_GNUC_[PRETTY_]FUNCTION

View File

@ -1283,12 +1283,12 @@ g_checksum_get_string (GChecksum *checksum)
/** /**
* g_checksum_get_digest: * g_checksum_get_digest:
* @checksum: a #GChecksum * @checksum: a #GChecksum
* @digest: output buffer * @buffer: output buffer
* @digest_len: an inout parameter. The caller initializes it to the size of @buffer. * @digest_len: an inout parameter. The caller initializes it to the size of @buffer.
* After the call it contains the length of the digest. * After the call it contains the length of the digest.
* *
* Gets the digest from @checksum as a raw binary vector and places it * Gets the digest from @checksum as a raw binary vector and places it
* into @digest. The size of the digest depends on the type of checksum. * into @buffer. The size of the digest depends on the type of checksum.
* *
* Once this function has been called, the #GChecksum is closed and can * Once this function has been called, the #GChecksum is closed and can
* no longer be updated with g_checksum_update(). * no longer be updated with g_checksum_update().

View File

@ -614,7 +614,7 @@ g_test_minimized_result (double minimized_quantity,
} }
/** /**
* g_test_minimized_result: * g_test_maximized_result:
* @maximized_quantity: the reported value * @maximized_quantity: the reported value
* @format: the format string of the report message * @format: the format string of the report message
* *

View File

@ -3183,7 +3183,7 @@ _glib_get_locale_dir (void)
/** /**
* glib_gettext: * glib_gettext:
* str: The string to be translated * @str: The string to be translated
* *
* Returns the translated string from the glib translations. * Returns the translated string from the glib translations.
* This is an internal function and should only be used by * This is an internal function and should only be used by