Expand docs

svn path=/trunk/; revision=7822

diff --git a/gio/ChangeLog b/gio/ChangeLog
index dcd5282ea1bf9a03d531951a3715af9cf490acb8..4c89223463f54aeda22461019b5d7b8a9b8f1d82 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,7 @@
+2009-01-19  Matthias Clasen  <mclasen@redhat.com>
+
+       * gdesktopappinfo.c (g_desktop_app_info_new): Expand the docs.
+
 2009-01-19  Matthias Clasen  <mclasen@redhat.com>
 
        * === Released 2.19.5 ===

diff --git a/gio/gdesktopappinfo.c b/gio/gdesktopappinfo.c
index 2ea2e811119bddebe76a687ff0cb493f0a1eb60a..4cb21546d06414f3d5696972817cd9ed6b9784bb 100644 (file)
--- a/gio/gdesktopappinfo.c
+++ b/gio/gdesktopappinfo.c
@@ -331,10 +331,20 @@ g_desktop_app_info_new_from_filename (const char *filename)
  * g_desktop_app_info_new:
  * @desktop_id: the desktop file id
  * 
- * Creates a new #GDesktopAppInfo.
+ * Creates a new #GDesktopAppInfo based on a desktop file id. 
+ *
+ * A desktop file id is the basename of the desktop file, including the 
+ * .desktop extension. GIO is looking for a desktop file with this name 
+ * in the <filename>applications</filename> subdirectories of the XDG data
+ * directories (i.e. the directories specified in the 
+ * <envar>XDG_DATA_HOME</envar> and <envar>XDG_DATA_DIRS</envar> environment 
+ * variables). GIO also supports the prefix-to-subdirectory mapping that is
+ * described in the <ulink url="http://standards.freedesktop.org/menu-spec/latest/">Menu Spec</ulink> 
+ * (i.e. a desktop id of kde-foo.desktop will match
+ * <filename>/usr/share/applications/kde/foo.desktop</filename>).
  * 
  * Returns: a new #GDesktopAppInfo, or %NULL if no desktop file with that id
- **/
+ */
 GDesktopAppInfo *
 g_desktop_app_info_new (const char *desktop_id)
 {