From 2f653f03c381cd6c4b1c7fc3aa7b25901fc8b47f Mon Sep 17 00:00:00 2001 From: Michał Górny Date: Mon, 28 Dec 2020 10:12:24 +0100 Subject: eclass: [QA] Revert multiple meaningless doc changes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Revert multiple meaningless eclass documentation changes, notably adding a lot of placeholders and documenting implementation details. These changes were aimed at silencing (valid) documentation warnings without actually providing valuable documentation to the end users. While some of these changes were beneficial, it would take a lot of effort to review them all and the author is unwilling to fix his mistakes. Signed-off-by: Michał Górny --- eclass/java-utils-2.eclass | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'eclass/java-utils-2.eclass') diff --git a/eclass/java-utils-2.eclass b/eclass/java-utils-2.eclass index 84c09885c7ba..b0d4d8acbefc 100644 --- a/eclass/java-utils-2.eclass +++ b/eclass/java-utils-2.eclass @@ -1,4 +1,4 @@ -# Copyright 2004-2018 Gentoo Authors +# Copyright 2004-2020 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: java-utils-2.eclass @@ -1484,6 +1484,7 @@ java-pkg_ensure-vm-version-sufficient() { # @FUNCTION: java-pkg_is-vm-version-sufficient # @INTERNAL +# @DESCRIPTION: # @RETURN: zero - VM is sufficient; non-zero - VM is not sufficient java-pkg_is-vm-version-sufficient() { debug-print-function ${FUNCNAME} $* @@ -1563,8 +1564,8 @@ java-pkg_ensure-vm-version-ge() { # Parameters: # $@ - VM version to compare current VM to # @CODE -# @RETURN: zero - current VM version is greater than checked version -# @RETURN: non-zero - current VM version is not greater than checked version +# @RETURN: zero - current VM version is greater than checked version; +# non-zero - current VM version is not greater than checked version java-pkg_is-vm-version-ge() { debug-print-function ${FUNCNAME} $* @@ -2591,14 +2592,14 @@ java-pkg_needs-vm() { # @FUNCTION: java-pkg_get-current-vm # @INTERNAL -# @RETURN: The current VM being used +# @RETURN - The current VM being used java-pkg_get-current-vm() { java-config -f } # @FUNCTION: java-pkg_get-vm-vendor # @INTERNAL -# @RETURN: The vendor of the current VM +# @RETURN - The vendor of the current VM java-pkg_get-vm-vendor() { debug-print-function ${FUNCNAME} $* @@ -2609,7 +2610,7 @@ java-pkg_get-vm-vendor() { # @FUNCTION: java-pkg_get-vm-version # @INTERNAL -# @RETURN: The version of the current VM +# @RETURN - The version of the current VM java-pkg_get-vm-version() { debug-print-function ${FUNCNAME} $* -- cgit v1.2.3-65-gdbad