Small doc additions.

diff --git a/ChangeLog b/ChangeLog
index 26b8875..95717e5 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -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)
 

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 26b8875..95717e5 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -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)
 

diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index 26b8875..95717e5 100644 (file)
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -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)
 

diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4
index 26b8875..95717e5 100644 (file)
--- a/ChangeLog.pre-2-4
+++ b/ChangeLog.pre-2-4
@@ -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)
 

diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index 26b8875..95717e5 100644 (file)
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -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)
 

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 26b8875..95717e5 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -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)
 

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index a2e9f90..6be1a2b 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -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.

diff --git a/docs/reference/glib/tmpl/misc_utils.sgml b/docs/reference/glib/tmpl/misc_utils.sgml
index 0553a9b..a7b07f2 100644 (file)
--- a/docs/reference/glib/tmpl/misc_utils.sgml
+++ b/docs/reference/glib/tmpl/misc_utils.sgml
@@ -54,12 +54,30 @@ reasons this function can only be called once.
 
 <!-- ##### FUNCTION g_getenv ##### -->
 <para>
-Returns an environment variable.
+
+</para>
+
+@variable:
+@Returns: 
+
+
+<!-- ##### FUNCTION g_setenv ##### -->
+<para>
+
+</para>
+
+@variable: 
+@value: 
+@overwrite: 
+@Returns: 
+
+
+<!-- ##### FUNCTION g_unsetenv ##### -->
+<para>
+
 </para>
 
-@variable: the environment variable to get.
-@Returns: the value of the environment variable, or %NULL if the environment
-variable is not found.
+@variable: 
 
 
 <!-- ##### FUNCTION g_get_user_name ##### -->

diff --git a/glib/gutils.c b/glib/gutils.c
index 8629793..1efd754 100644 (file)
--- a/glib/gutils.c
+++ b/glib/gutils.c
@@ -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)
 {