1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
Commit Graph

9 Commits

Author SHA1 Message Date
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
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