Clarify g_get_prgname docs. (#161480, Danny Milo)
authorMatthias Clasen <mclasen@redhat.com>
Sat, 18 Dec 2004 02:06:58 +0000 (02:06 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Sat, 18 Dec 2004 02:06:58 +0000 (02:06 +0000)
2004-12-17  Matthias Clasen  <mclasen@redhat.com>

* glib/tmpl/misc_utils.sgml: Clarify g_get_prgname docs.
(#161480, Danny Milo)

docs/reference/ChangeLog
docs/reference/glib/tmpl/misc_utils.sgml

index 8d55d6b..9bc9dbc 100644 (file)
@@ -1,3 +1,8 @@
+2004-12-17  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/tmpl/misc_utils.sgml: Clarify g_get_prgname docs.  
+       (#161480, Danny Milo)
+
 2004-12-16  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/tmpl/version.sgml: Improve wording.  (#161484,
index 9511f09..4c75754 100644 (file)
@@ -32,19 +32,20 @@ These are portable utility functions.
 
 <!-- ##### FUNCTION g_get_prgname ##### -->
 <para>
-Gets the name of the program. This name should NOT be localized,
+Gets the name of the program. This name should <emphasis>not</emphasis> be localized,
 contrast with g_get_application_name().
 (If you are using GDK or GTK+ the program name is set in gdk_init(), which
 is called by gtk_init(). The program name is found by taking the last
 component of <literal>argv[0]</literal>.)
 </para>
 
-@Returns: the name of the program.
+@Returns: the name of the program. 
+  The returned string belongs to GLib and must not be modified or freed.
 
 
 <!-- ##### FUNCTION g_set_prgname ##### -->
 <para>
-Sets the name of the program. This name should NOT be localized, 
+Sets the name of the program. This name should <emphasis>not</emphasis> be localized, 
 contrast with g_set_application_name(). Note that for thread-safety
 reasons this function can only be called once.
 </para>