diff options
author | Jean-François Wauthy <pollux@xfce.org> | 2004-05-27 19:49:55 +0000 |
---|---|---|
committer | Jean-François Wauthy <pollux@xfce.org> | 2004-05-27 19:49:55 +0000 |
commit | 3a1ca9478e963deaeb646988f3811d0047236c88 (patch) | |
tree | 7bc35264b417290af15147cf70017ad1a0cc851e /docs | |
parent | 5e9e0472ff96f5d0a9deaa21f601920115240524 (diff) | |
download | libxfce4util-3a1ca9478e963deaeb646988f3811d0047236c88.tar.gz |
move documentation of xfce-desktopentry functions into the code
(Old svn revision: 830)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/tmpl/xfce-desktopentry.sgml | 51 |
1 files changed, 22 insertions, 29 deletions
diff --git a/docs/tmpl/xfce-desktopentry.sgml b/docs/tmpl/xfce-desktopentry.sgml index f9ce5ee..cf4e5da 100644 --- a/docs/tmpl/xfce-desktopentry.sgml +++ b/docs/tmpl/xfce-desktopentry.sgml @@ -23,16 +23,15 @@ XfceDesktopEntry implementation and should never be accessed directly. Instead, you should use the functions listed below. </para> - <!-- ##### FUNCTION xfce_desktop_entry_new ##### --> <para> -Create a new #XfceDesktopEntry object. + </para> -@file: full path to the desktop entry file to use. -@categories: array of categories, not necessarily NULL terminated. -@num_categories: number of items in @categories. -@Returns: newly created #XfceDesktopEntry or NULL if something goes wrong. +@file: +@categories: +@num_categories: +@Returns: <!-- ##### FUNCTION xfce_desktop_entry_new_from_data ##### --> @@ -48,48 +47,42 @@ Create a new #XfceDesktopEntry object. <!-- ##### FUNCTION xfce_desktop_entry_parse ##### --> <para> -Parses the desktop entry file and fills in the values for all categories. + </para> -@desktop_entry: an #XfceDesktopEntry. -@Returns: TRUE on success, FALSE on failure. +@desktop_entry: +@Returns: <!-- ##### FUNCTION xfce_desktop_entry_get_file ##### --> <para> -Obtain the path to the desktop entry file associated with the -#XfceDesktopEntry. + </para> -@desktop_entry: an #XfceDesktopEntry. -@Returns: path of the desktop entry file used to create @desktop_entry. The - return value should be considered read-only and must not be freed - by the caller. +@desktop_entry: +@Returns: <!-- ##### FUNCTION xfce_desktop_entry_get_string ##### --> <para> -Finds the value for @key. When @translated is TRUE the function will use -the translated value (using the current locale settings) if available or -the untranslated value if no translation can be found. + </para> -@desktop_entry: an #XfceDesktopEntry -@key: category to find value for. -@translated: set to TRUE if the translated value is preferred. -@value: location for the value, which will be newly allocated. -@Returns: TRUE on success, FALSE on failure. @value must be freed. +@desktop_entry: +@key: +@translated: +@value: +@Returns: <!-- ##### FUNCTION xfce_desktop_entry_get_int ##### --> <para> -Gets a value from @desktop_entry as integer. Therefore finds the value for -@key and returns its integer representation. + </para> -@desktop_entry: an #XfceDesktopEntry. -@key: category to find value for. -@value: location for the value. -@Returns: TRUE on success, FALSE on failure. +@desktop_entry: +@key: +@value: +@Returns: |