[patch] Proposed documentation fix for eutils.eclass

eutils.patch (text/plain), 1.57 KB, created by Alex Belykh on 2011-04-29 16:12:36 UTC

diff --git a/eutils.eclass b/eutils.eclass
index b2b10ff..ffa0a87 100644
--- a/eutils.eclass
+++ b/eutils.eclass
@@ -874,20 +874,17 @@ edos2unix() {
 	echo "$@" | xargs sed -i 's/\r$//'
 }
 
-# Make a desktop file !
-# Great for making those icons in kde/gnome startmenu !
-# Amaze your friends !	Get the women !	 Join today !
-#
-# make_desktop_entry(<command>, [name], [icon], [type], [fields])
-#
-# binary:	what command does the app run with ?
-# name:		the name that will show up in the menu
-# icon:		give your little like a pretty little icon ...
-#			this can be relative (to /usr/share/pixmaps) or
-#			a full path to an icon
-# type:		what kind of application is this ?	for categories:
-#			http://standards.freedesktop.org/menu-spec/latest/apa.html
-# fields:	extra fields to append to the desktop file; a printf string
+# @FUNCTION: make_desktop_entry
+# @USAGE: <binary>, [name], [icon], [type], [fields]
+# @DESCRIPTION:
+# Makes a desktop entry. The first argument contains the path to the binary.
+# Optionally, the second contains a name for the icon - the default is ${PN}.
+# The third can contain a path to the icon relative to /usr/share/pixmaps or 
+# a full path - the default is ${PN}.png. The fourth can contain an 
+# application category
+# (http://standards.freedesktop.org/menu-spec/latest/apa.html). The fifth
+# argument can contain extra fields to append to the desktop file, in form of a
+# string subjected to backslash expansion (e.g \n becomes end-of-line character).
 make_desktop_entry() {
 	[[ -z $1 ]] && die "make_desktop_entry: You must specify the executable"