Improve docs [ci skip]

Signed-off-by: Paolo Di Tommaso <[email protected]>
nextflow-io · Nov 14, 2024 · 3ca75fd · 3ca75fd
1 parent 4dea3a3
commit 3ca75fd
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/modules/nextflow/src/main/groovy/nextflow/Nextflow.groovy b/modules/nextflow/src/main/groovy/nextflow/Nextflow.groovy
@@ -61,6 +61,9 @@ class Nextflow {
      * Get the value of an environment variable from the launch environment.
      *
      * @param name
+     *      The environment variable name to be referenced
+     * @return
+     *      The value associate with the specified variable name or {@code null} if the variable does not exist.
      */
     static String env(String name) {
         return SysEnv.get(name)

diff --git a/modules/nextflow/src/main/groovy/nextflow/config/ConfigBase.groovy b/modules/nextflow/src/main/groovy/nextflow/config/ConfigBase.groovy
@@ -78,6 +78,9 @@ abstract class ConfigBase extends Script {
      * Get the value of an environment variable from the launch environment.
      *
      * @param name
+     *      The environment variable name to be referenced
+     * @return
+     *      The value associate with the specified variable name or {@code null} if the variable does not exist.
      */
     String env(String name) {
         return SysEnv.get(name)