summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin Lecher <jlec@gentoo.org>2012-01-03 08:45:36 +0000
committerJustin Lecher <jlec@gentoo.org>2012-01-03 08:45:36 +0000
commit5a5fe0464d8ff58735e271d05ce24a024925b6c4 (patch)
tree1b0f8e64eee05d0e4bbfa42be1e1b7ef4b76e2ff /eclass/eutils.eclass
parentUse doc array to make everyone happy. (diff)
downloadhistorical-5a5fe0464d8ff58735e271d05ce24a024925b6c4.tar.gz
historical-5a5fe0464d8ff58735e271d05ce24a024925b6c4.tar.bz2
historical-5a5fe0464d8ff58735e271d05ce24a024925b6c4.zip
Convert make_desktop_entry() comment block to be eclass-manpages conform, #397451
Diffstat (limited to 'eclass/eutils.eclass')
-rw-r--r--eclass/eutils.eclass29
1 files changed, 16 insertions, 13 deletions
diff --git a/eclass/eutils.eclass b/eclass/eutils.eclass
index 65ac10c99ffb..e06ea4830334 100644
--- a/eclass/eutils.eclass
+++ b/eclass/eutils.eclass
@@ -1,6 +1,6 @@
# Copyright 1999-2011 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.376 2011/12/17 06:13:50 vapier Exp $
+# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.377 2012/01/03 08:45:36 jlec Exp $
# @ECLASS: eutils.eclass
# @MAINTAINER:
@@ -609,20 +609,23 @@ edos2unix() {
sed -i 's/\r$//' -- "$@" || die
}
-# 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])
+# @FUNCTION: make_desktop_entry
+# @USAGE: make_desktop_entry(<command>, [name], [icon], [type], [fields])
+# @DESCRIPTION:
+# Make a .desktop file.
#
-# 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
+# @CODE
+# 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
+# if unset, function tries to guess from package's category
# fields: extra fields to append to the desktop file; a printf string
+# @CODE
make_desktop_entry() {
[[ -z $1 ]] && die "make_desktop_entry: You must specify the executable"