mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-12 10:55:20 +02:00
f757a0e1d4
* fix Markdown issue 'Headers should be surrounded by blank lines' * fix MD012 * fix MD022 * fix MD026 * fix MD007 * fix MD032 * fix MD038 * fix MD040 * fix MD031 * fix MD034 * fix MD004 * fix new findings * fix MD036 * fix MD038 * fix MD032 * fix MD006
60 lines
802 B
Markdown
60 lines
802 B
Markdown
# <script name>
|
|
|
|
## Description
|
|
|
|
Brief description.
|
|
|
|
## Constructors
|
|
|
|
### <script name>(<arguments>)
|
|
|
|
#### Parameters
|
|
|
|
| parameter | mandatory | default | possible values |
|
|
| ---------------|-----------|-----------------------------------|--------------------|
|
|
| | | | |
|
|
|
|
* `<parameter>` - Detailed description of each parameter.
|
|
|
|
#### Exceptions
|
|
|
|
* `ExceptionType`
|
|
* List of cases when exception is thrown.
|
|
|
|
#### Example
|
|
|
|
```groovy
|
|
|
|
```
|
|
|
|
## Method Details
|
|
|
|
### <method>(<arguments>)
|
|
|
|
#### Description
|
|
|
|
Brief description.
|
|
|
|
#### Parameters
|
|
|
|
* `<parameter>` - Detailed description of each parameter.
|
|
|
|
#### Return value
|
|
|
|
none
|
|
|
|
#### Side effects
|
|
|
|
none
|
|
|
|
#### Exceptions
|
|
|
|
* `ExceptionType`
|
|
* List of cases when exception is thrown.
|
|
|
|
#### Example
|
|
|
|
```groovy
|
|
|
|
```
|