Skip to content

Commit 081b893

Browse files
authored
added parameter description
1 parent a0b0ca8 commit 081b893

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

documentation/Functions.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,9 +268,15 @@ Repository will be cloned into a newly created subdirectory devonfw-tutorials.
268268
### runServerJava <a name="runServerJava"></a>
269269
This function will run your Java application on server.Parameter and assertion information you need to use properly, which is mentioned below.In Katacoda the command will be executed in a new terminal.
270270
#### parameter
271-
There are two parameters you need to use.
272-
1. 1st Parameter(devonfw/workspaces/main/jump-the-queue/java/jtqj/server)-Path to the server directory within the Java project.
273-
2. 2nd Parameter({ "startupTime": 40, "port": 8081, "path": "jumpthequeue" })-Assertion information. Only needed for the console runner to check if the server was started properly.
271+
This functions consists of two parameters.
272+
1. 1st Parameter:
273+
- **Required**
274+
- **Type**- String
275+
- **Description**- Path to the server directory within the Java project.
276+
2. 2nd Parameter:
277+
- **Required**
278+
- **Type**- JSON object
279+
- **Description**- Assertion information. Only needed for the console runner to check if the server was started properly.
274280
#### example
275281
runServerJava("devonfw/workspaces/main/jump-the-queue/java/jtqj/server", { "startupTime": 40, "port": 8081, "path": "jumpthequeue" })
276282

@@ -280,6 +286,8 @@ port: Port on which the server is running
280286
path: The URL path on which is checked if the server is running
281287

282288
If the tutorial should be tested on the console environment, you have to specify a port.
289+
290+
Note: To execute this function, devonfw-ide must be installed.
283291
***
284292

285293
### npmInstall <a name="npmInstall"></a>

0 commit comments

Comments
 (0)