2017-11-27 12:28:26 +02:00
|
|
|
# <script name>
|
|
|
|
|
|
|
|
## Description
|
2018-11-06 14:50:09 +02:00
|
|
|
|
2017-11-27 12:28:26 +02:00
|
|
|
Brief description.
|
|
|
|
|
|
|
|
## Constructors
|
|
|
|
|
|
|
|
### <script name>(<arguments>)
|
|
|
|
|
|
|
|
#### Parameters
|
2018-11-06 14:50:09 +02:00
|
|
|
|
2017-11-27 12:28:26 +02:00
|
|
|
| parameter | mandatory | default | possible values |
|
|
|
|
| ---------------|-----------|-----------------------------------|--------------------|
|
|
|
|
| | | | |
|
|
|
|
|
|
|
|
* `<parameter>` - Detailed description of each parameter.
|
|
|
|
|
|
|
|
#### Exceptions
|
2018-11-06 14:50:09 +02:00
|
|
|
|
2017-11-27 12:28:26 +02:00
|
|
|
* `ExceptionType`
|
2018-11-06 14:50:09 +02:00
|
|
|
* List of cases when exception is thrown.
|
2017-11-27 12:28:26 +02:00
|
|
|
|
|
|
|
#### Example
|
2018-11-06 14:50:09 +02:00
|
|
|
|
2017-11-27 12:28:26 +02:00
|
|
|
```groovy
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
## Method Details
|
|
|
|
|
|
|
|
### <method>(<arguments>)
|
|
|
|
|
|
|
|
#### Description
|
2018-11-06 14:50:09 +02:00
|
|
|
|
2017-11-27 12:28:26 +02:00
|
|
|
Brief description.
|
|
|
|
|
|
|
|
#### Parameters
|
2018-11-06 14:50:09 +02:00
|
|
|
|
2017-11-27 12:28:26 +02:00
|
|
|
* `<parameter>` - Detailed description of each parameter.
|
|
|
|
|
|
|
|
#### Return value
|
2018-11-06 14:50:09 +02:00
|
|
|
|
2017-11-27 12:28:26 +02:00
|
|
|
none
|
|
|
|
|
|
|
|
#### Side effects
|
2018-11-06 14:50:09 +02:00
|
|
|
|
2017-11-27 12:28:26 +02:00
|
|
|
none
|
|
|
|
|
|
|
|
#### Exceptions
|
2018-11-06 14:50:09 +02:00
|
|
|
|
2017-11-27 12:28:26 +02:00
|
|
|
* `ExceptionType`
|
2018-11-06 14:50:09 +02:00
|
|
|
* List of cases when exception is thrown.
|
2017-11-27 12:28:26 +02:00
|
|
|
|
|
|
|
#### Example
|
2018-11-06 14:50:09 +02:00
|
|
|
|
2017-11-27 12:28:26 +02:00
|
|
|
```groovy
|
|
|
|
|
|
|
|
```
|