luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-02 05:43:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve g_strerror and g_strsignal docs. Bug #438293.

Browse Source 
2007-05-14  Christian Persch  <chpe@gnome.org>

	* docs/reference/glib/tmpl/string_utils.sgml: Improve g_strerror and
	g_strsignal docs. Bug #438293.

svn path=/trunk/; revision=5491
This commit is contained in:
Christian Persch 2007-05-14 17:14:11 +00:00 committed by Christian Persch
parent 20d47d6f9b
commit 15d995bc79
2 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2007-05-14 Christian Persch <chpe@gnome.org>
* docs/reference/glib/tmpl/string_utils.sgml: Improve g_strerror and
g_strsignal docs. Bug #438293.
2007-05-13 Tor Lillqvist <tml@novell.com> 2007-05-13 Tor Lillqvist <tml@novell.com>
* glib/gwin32.h: Drop the pipe() macro. Defining macros outside of * glib/gwin32.h: Drop the pipe() macro. Defining macros outside of

10
docs/reference/glib/tmpl/string_utils.sgml
View File

@ -913,13 +913,14 @@ together, with @separator between them.
<!-- ##### FUNCTION g_strerror ##### --> <!-- ##### FUNCTION g_strerror ##### -->
<para> <para>
Returns a string corresponding to the given error code, e.g. "no such process". Returns a string corresponding to the given error code, e.g. "no such process".
This function is included since not all platforms support the You should use this function in preference to strerror(), because it returns a
string in UTF-8 encoding, and since not all platforms support the
strerror() function. strerror() function.
</para> </para>
@errnum: the system error number. See the standard C %errno @errnum: the system error number. See the standard C %errno
documentation. documentation.
@Returns: a string describing the error code. @Returns: a UTF-8 string describing the error code.
If the error code is unknown, it returns "unknown error (&lt;code&gt;)". If the error code is unknown, it returns "unknown error (&lt;code&gt;)".
The string can only be used until the next call to g_strerror(). The string can only be used until the next call to g_strerror().
@ -927,13 +928,14 @@ The string can only be used until the next call to g_strerror().
<!-- ##### FUNCTION g_strsignal ##### --> <!-- ##### FUNCTION g_strsignal ##### -->
<para> <para>
Returns a string describing the given signal, e.g. "Segmentation fault". Returns a string describing the given signal, e.g. "Segmentation fault".
This function is included since not all platforms support the You should use this function in preference to strsignal(), because it returns a
string in UTF-8 encoding, and since not all platforms support the
strsignal() function. strsignal() function.
</para> </para>
@signum: the signal number. See the <literal>signal</literal> @signum: the signal number. See the <literal>signal</literal>
documentation. documentation.
@Returns: a string describing the signal. @Returns: a UTF-8 string describing the signal.
If the signal is unknown, it returns "unknown signal (&lt;signum&gt;)". If the signal is unknown, it returns "unknown signal (&lt;signum&gt;)".
The string can only be used until the next call to g_strsignal(). The string can only be used until the next call to g_strsignal().