Sven Merk
bfbee88620
Added documentation of parameters and step
2019-03-06 15:08:42 +01:00
Christopher Fenner
3f12015364
dockerExecuteOnKubernetes: generate documentation ( #487 )
...
* fix whitespace
* correct key order
* add docs annotation
* add key documentation
* remove generated documentation
* fix code climate finding
2019-02-08 12:20:45 +01:00
Marcus Holl
34b7c24faf
Merge remote-tracking branch 'github/master' into HEAD
2019-02-05 16:37:49 +01:00
Marcus Holl
22340ebb25
allow single line comments
...
like this /** short comment */
rather than
/**
* short comment
*/
2019-02-04 12:41:38 +01:00
Marcus Holl
89fd30e84c
implement @see strategy
...
in case there is a pseudo annotation '@see' found in a step docu the docu is retrived from
the parameter with the same name in the other step. Format is:
'@see <OTHER_STEP_NAME>'
This simplifies documentation for parameters with same name and same
semantics used in more than one step.
2019-02-01 16:59:54 +01:00
Marcus Holl
50edac02ca
First char after docu asterisk is pruned
...
... with a blank after the asterisk the docu looks more beautifyfull.
2019-01-29 17:30:26 +01:00
Marcus Holl
8fb7c85e99
keep leading blanks in order to render 'git diff! Note' statements
2019-01-29 17:30:25 +01:00
Christopher Fenner
4f804f8876
remove trailing line breaks
2019-01-18 08:57:54 +01:00
Marcus Holl
6f59627551
Create file containing classpath into build dir
...
and not into project root. With this appraoch the root folder get not
filled with temporary content.
2019-01-18 08:57:54 +01:00
Marcus Holl
760137058c
Evaluate @GenerateDocumentation annotation.
2019-01-18 08:57:54 +01:00
Marcus Holl
f81dc7b147
docu script classpath contains the built classes folder
...
we do not have only groovy script, but also java files inside src folder.
Hence we should rely on the target/classes folder in order to see also the
compiled java classes, and not only the groovy scripts.
2019-01-18 08:57:54 +01:00
Marcus Holl
daaac272d6
Remove commented coding line
2019-01-18 08:57:54 +01:00
Marcus Holl
c6500a7516
Relocate script files for generting documention
2019-01-18 08:57:54 +01:00
