diff --git a/documentation/functions.asciidoc b/documentation/functions.asciidoc index cc5ad7fb1..57c71f9ad 100644 --- a/documentation/functions.asciidoc +++ b/documentation/functions.asciidoc @@ -37,7 +37,7 @@ Display a question and ask the user if he wants to continue. In xref:doIsForce[force] or xref:doIsBatch[batch] mode, it will continue automatically. |======================= -|*Param*|*Name* |*Description*| +|*Param*|*Name* |*Description* |`$1` |question|The question to display. Defaults to `Do you want to continue?`. |`$2` |return |If the user does not want to continue, this function will exit immediately by default. However, if `return` is passed the function will return 255 and the called can handle the program flow. |======================= @@ -105,7 +105,7 @@ Will print the operation (`$1`) as xref:doSuccess[success] message if exitCode ( Otherwise it will pass it to xref:doFail[]. |======================= -|*Param*|*Name* |*Description*| +|*Param*|*Name* |*Description* |`$1` |operation |The operation that failed or succeeded. |`$2` |exitCode |`0` for sucess, otherwise the error code. |======================= @@ -151,7 +151,7 @@ Further it xref:doError[prints an error message] if the commandlet was not succe It will return with the exit code of the commandlet that has been invoked. |======================= -|*Param*|*Name* |*Description*| +|*Param*|*Name* |*Description* |`$1` |commandlet |The devonfw-ide commandlet to call. E.g. `help` or `ide`. |`$2`-$n|args |Any additional argument is passed to the specified commandlet. |======================= @@ -162,7 +162,7 @@ If a a third parameter (`$3`) is provided, it has to point to an existing direct It will use xref:doResult[] using the `message` (`$2`) to handle the result of the command execution (success or failure). |======================= -|*Param*|*Name* |*Description*| +|*Param*|*Name* |*Description* |`$1` |command |The command to execute including all its parameters. |`$2` |message |Optional description of the command. Will fall back to "run command" followed by a simplification of the command (`$1`). |`$3` |dir |Optional working directory where to execute the command. @@ -186,7 +186,7 @@ Downloads an artifact from the internet. If the URL is not provided as first argument, it will use the `mirrors` config to automatically determine the URL from the other arguments. |======================= -|*Param*|*Name* |*Description*| +|*Param*|*Name* |*Description* |`$1` |URL |The explicit URL to download from or `-` to compute in xref:doDownload[]. |`$2` |dir |The optional target directory where to save the downloaded file. |`$3` |name |The name of the software to download. @@ -238,7 +238,7 @@ Following the doInstall call in the commandlet, the installation of the software * If parameters five through nine (edition, code, os, arch, and ext) are specified, they are passed directly to the doDownload function. |======================= -|*Param*|*Name* |*Description*| +|*Param*|*Name* |*Description* |`$1` |URL |The explicit URL to download from or `-` to compute in xref:doDownload[]. |`$2` |path |The absolute target path where to install the software. |`$3` |name |The name of the software to install.