Sven Merk
991dd5ec51
Merge branch 'master' into whitesource-step
2019-03-22 11:58:01 +01:00
Sven Merk
be814c62aa
Included comments refactored docu generation
2019-03-21 13:25:22 +01:00
Marcus Holl
bf48f18f3e
take parameters keys into account again.
...
was removed since parameter keys does not appear anymore in the table denoting the
level where a parameter can be configured.
Nevertheless we need to take that parameter into account. We need to add the description for
that parameter, even if it cannot be configured on general or stage level.
2019-03-15 15:24:06 +01:00
Marcus Holl
52f3287cb3
Merge remote-tracking branch 'github/master' into HEAD
2019-03-15 15:01:12 +01:00
Sven Merk
6b61bc1b98
Updated documentation
2019-03-08 12:33:31 +01:00
Sven Merk
bfbee88620
Added documentation of parameters and step
2019-03-06 15:08:42 +01:00
weloli
47ba7ff035
reduce redunadancy in md files for doc generation
2019-02-18 08:20:16 +01:00
weloli
0d0fe3a2a8
fix according to last agreement
2019-02-13 14:29:05 +01:00
weloli
184613a78b
Merge branch 'master' of https://github.com/weloli/jenkins-library into pr/fixStageDoc
2019-02-08 16:09:41 +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
weloli
35e14f9667
fix stage definition
2019-02-08 10:10:02 +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
760137058c
Evaluate @GenerateDocumentation annotation.
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
