Add missing documentation.

1 files changed, 28 insertions, 0 deletions

diff --git a/ruby-ng-testbed/eclass/ruby-fakegem.eclass b/ruby-ng-testbed/eclass/ruby-fakegem.eclass
index eb8256e..4a247d8 100644
--- a/ruby-ng-testbed/eclass/ruby-fakegem.eclass
+++ b/ruby-ng-testbed/eclass/ruby-fakegem.eclass
@@ -156,12 +156,19 @@ EOF
 	) || die "Unable to create fakegem wrapper"
 }
 
+# @FUNCTION: all_fakegem_compile
+# @DESCRIPTION:
+# Build documentation for the package if indicated by the doc USE flag
+# and if there is a documetation task defined.
 all_fakegem_compile() {
 	if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]] && use doc; then
 		rake ${RUBY_FAKEGEM_TASK_DOC} || die "failed to (re)build documentation"
 	fi
 }
 
+# @FUNCTION: all_ruby_unpack
+# @DESCRIPTION:
+# Unpack the source archive, including support for unpacking gems.
 all_ruby_unpack() {
 	# Special support for extracting .gem files; the file need to be
 	# extracted twice and the mtime from the archive _has_ to be
@@ -186,10 +193,16 @@ all_ruby_unpack() {
 	fi
 }
 
+# @FUNCTION: all_ruby_compile
+# @DESCRIPTION:
+# Compile the package.
 all_ruby_compile() {
 	all_fakegem_compile
 }
 
+# @FUNCTION: each_fakegem_test
+# @DESCRIPTION:
+# Run tests for the package for each ruby target if the test task is defined.
 each_fakegem_test() {
 	local rubyflags=
 
@@ -200,10 +213,16 @@ each_fakegem_test() {
 	fi
 }
 
+# @FUNCTION: each_ruby_test
+# @DESCRIPTION:
+# Run the tests for this package.
 each_ruby_test() {
 	each_fakegem_test
 }
 
+# @FUNCTION: each_fakegem_install
+# @DESCRIPTION:
+# Install the package for each ruby target.
 each_fakegem_install() {
 	ruby_fakegem_genspec
 
@@ -215,10 +234,16 @@ each_fakegem_install() {
 	ruby_fakegem_doins -r ${_gemlibdirs}
 }
 
+# @FUNCTION: each_ruby_install
+# @DESCRIPTION:
+# Install the package for each target.
 each_ruby_install() {
 	each_fakegem_install
 }
 
+# @FUNCTION: all_fakegem_install
+# @DESCRIPTION:
+# Install files common to all ruby targets.
 all_fakegem_install() {
 	if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then
 		pushd ${RUBY_FAKEGEM_DOCDIR}
@@ -231,6 +256,9 @@ all_fakegem_install() {
 	fi
 }
 
+# @FUNCTION: all_ruby_install
+# @DESCRIPTION:
+# Install files common to all ruby targets.
 all_ruby_install() {
 	all_fakegem_install
 }