Small doc additions.

This commit is contained in:
Matthias Clasen 2003-07-30 19:00:36 +00:00
parent beca86c32b
commit b3814b0cdc
9 changed files with 40 additions and 4 deletions

View File

@ -1,6 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de>
* glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc.
(g_getenv): Move docs inline, add comment about lifespan of return value.
* glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt)

View File

@ -1,6 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de>
* glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc.
(g_getenv): Move docs inline, add comment about lifespan of return value.
* glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt)

View File

@ -1,6 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de>
* glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc.
(g_getenv): Move docs inline, add comment about lifespan of return value.
* glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt)

View File

@ -1,6 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de>
* glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc.
(g_getenv): Move docs inline, add comment about lifespan of return value.
* glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt)

View File

@ -1,6 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de>
* glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc.
(g_getenv): Move docs inline, add comment about lifespan of return value.
* glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt)

View File

@ -1,6 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de>
* glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc.
(g_getenv): Move docs inline, add comment about lifespan of return value.
* glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt)

View File

@ -1,5 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de>
* glib/tmpl/misc_utils.sgml: Move g_getenv() docs inline.
* glib/tmpl/string_utils.sgml: Small fixes.
* glib/glib-docs.sgml: Add paragraph about multi-threading policy.

View File

@ -54,12 +54,30 @@ reasons this function can only be called once.
<!-- ##### FUNCTION g_getenv ##### -->
<para>
Returns an environment variable.
</para>
@variable: the environment variable to get.
@Returns: the value of the environment variable, or %NULL if the environment
variable is not found.
@variable:
@Returns:
<!-- ##### FUNCTION g_setenv ##### -->
<para>
</para>
@variable:
@value:
@overwrite:
@Returns:
<!-- ##### FUNCTION g_unsetenv ##### -->
<para>
</para>
@variable:
<!-- ##### FUNCTION g_get_user_name ##### -->

View File

@ -609,6 +609,16 @@ g_get_current_dir (void)
return dir;
}
/**
* g_getenv:
* @variable: the environment variable to get.
*
* Returns an environment variable.
*
* Return value: the value of the environment variable, or %NULL if the environment
* variable is not found. The returned string may be overwritten by the next call to g_getenv(),
* g_setenv() or g_unsetenv().
**/
G_CONST_RETURN gchar*
g_getenv (const gchar *variable)
{