games-engines/love: add documentation to love.exlib

packages/games-engines/love/love.exlib

@@ -1,6 +1,19 @@
 # Copyright 2016 Julian Ospald <hasufell@posteo.de>
 # Distributed under the terms of the GNU General Public License v2
 
+# Purpose: an exlib dealing with installation of the love engine
+# Maintainer: Julian Ospald <hasufell@posteo.de>
+# Exports: src_prepare src_install pkg_postinst
+# Side-effects: - adds build and runtime dependencies
+#               - sets $SUMMARY, $WORK, $HOMEPAGE, $DOWNLOADS, $LICENCES,
+#                      $DEFAULT_SRC_CONFIGURE_PARAMS,
+#                      $DEFAULT_SRC_INSTALL_EXTRA_DOCS,
+#               - imports alternatives, lua,
+#                         autotools depending on $LOVE_AUTOCONF
+#
+# Usage
+#   Set LOVE_AUTOCONF before 'require' to force autoreconf
+
 require alternatives
 require lua [ whitelist="5.1" multibuild="false" ]
 
@@ -15,7 +28,6 @@ HOMEPAGE="http://love2d.org/"
 DOWNLOADS="https://bitbucket.org/rude/love/downloads/love-${PV}-linux-src.tar.gz"
 
 LICENCES="ZLIB"
-MYOPTIONS=""
 
 DEPENDENCIES="
     build:
@@ -45,6 +57,7 @@ fi
 
 DEFAULT_SRC_INSTALL_EXTRA_DOCS=( "readme.md" "changes.txt" )
 
+# Exported 'src_prepare'.
 love_src_prepare() {
     if [[ -n ${LOVE_AUTOCONF} ]]; then
         edo cp platform/unix/{configure.ac,Makefile.am} .
@@ -55,10 +68,12 @@ love_src_prepare() {
     fi
 }
 
+# Exported 'src_install'.
 love_src_install() {
     newbin src/${PN} ${PN}-${SLOT}
     emagicdocs
 
+    # set up alternatives based on SLOT
     local host=$(exhost --target)
     local binaries=( love love-${SLOT} )
 
@@ -67,6 +82,7 @@ love_src_install() {
     done
 }
 
+# Exported 'pkg_postinst'.
 love_pkg_postinst() {
     alternatives_pkg_postinst
 }