Marcus Holl
36a282a8f2
docu generator: script:this case code
2018-11-23 14:43:04 +01:00
Marcus Holl
c9359b63a1
Support mandatory flag when generating docu
2018-11-23 14:43:04 +01:00
Marcus Holl
b921aa8d2a
[fix] load defaults
2018-11-23 09:21:14 +01:00
Marcus Holl
ddbdc034fc
Handle annotations without docu generator on call method
2018-11-20 16:53:00 +01:00
Marcus Holl
6333530c9d
Insert newlines before param config layers table
2018-11-20 16:53:00 +01:00
Marcus Holl
12a41cfad2
Fix identations
2018-11-05 10:19:57 +01:00
Marcus Holl
59f542d337
Fix identations
2018-11-05 10:16:20 +01:00
Marcus Holl
50b3ed0999
Fix identations
2018-11-05 10:14:01 +01:00
Marcus Holl
30f373b66b
Fix identations
2018-11-05 10:04:04 +01:00
Marcus Holl
30569102da
Fix identations
2018-11-05 09:51:28 +01:00
Marcus Holl
59bf6b0545
Fix identations
2018-11-05 09:31:47 +01:00
Marcus Holl
77a600dfbd
Fix identations
2018-11-05 09:24:56 +01:00
Marcus Holl
4b8b1abb1c
Merge remote-tracking branch 'github/master' into HEAD
2018-11-05 09:08:21 +01:00
Marcus Holl
2fdf414de9
Improve: where the parameters can be configured
2018-11-02 15:04:13 +01:00
Marcus Holl
d410ddea59
Remove prerequisites from docu inside step
...
--> will be contained in the md file instead.
2018-11-02 15:04:12 +01:00
Marcus Holl
84476322ff
Replace parameter directly without using tags in the text
2018-11-02 15:04:12 +01:00
Marcus Holl
66b79947ed
Avoid trailing whitespaces
...
caused by empty lines in the javadoc like documentation
2018-10-30 08:03:49 +01:00
Marcus Holl
5ca2f1530e
Render step configuration section
2018-10-29 16:31:19 +01:00
Marcus Holl
bfd904d8b3
Exception handing when rendering steps
2018-10-29 15:25:51 +01:00
Marcus Holl
1bc9ed4488
No backticks in case we have the empty string as a default value
2018-10-29 15:25:16 +01:00
Marcus Holl
f09cd638bb
Separate step rendering from step evaluation
...
... in preparation of additional tags making use of interdependencies between steps,
e.g. something like a '@see' tag for re-using descriptions from other steps.
2018-10-29 14:02:16 +01:00
Marcus Holl
67bc3f633d
Relocate 'done' message.
2018-10-29 13:39:37 +01:00
Marcus Holl
fd46329bd1
The empty string instead of 'n/a' in case no value is available
2018-10-29 13:37:58 +01:00
Marcus Holl
5798b0a236
Special handling for 'script' parameter
2018-10-29 13:09:20 +01:00
Marcus Holl
1624001826
Introduce header comment handling
...
... and several other fixes
2018-10-29 12:57:10 +01:00
Marcus Holl
77419882dd
scanNextLineForParam -> docuEnd
...
since this naming is more open, e.g. when dealing with header comments we do not
scan the next line for a parameter.
2018-10-29 08:09:36 +01:00
Marcus Holl
9532e1c05d
WIP: header comment
2018-10-29 08:09:34 +01:00
Marcus Holl
44cf1c6f47
Emit a warning to the log in case the same parameter is documented twice.
2018-10-26 12:21:06 +02:00
Marcus Holl
a8eb963ac2
Support javadoc like comments for parameters specified in a config key list
...
up to now we onls took withMandatory parameter sections into account
2018-10-26 12:14:03 +02:00
Marcus Holl
d5c89e8b4a
-Provide option for generating docu for a single step
2018-10-26 12:08:34 +02:00
Marcus Holl
836eff22b9
Blacklist removed
...
was only intended to speed-up early development of the script.
2018-10-26 11:59:48 +02:00
Marcus Holl
b7f2ca8c5b
Be more failsafe when creating documentation
...
we do not fail immediatly, instead we continue with the next step. Of course we emit a warning/error into
the log in case of a failure.
In case there is a failure the script returns with != 0
2018-10-26 11:48:11 +02:00
Marcus Holl
f8c48e980d
@value -> @possibleValues
2018-10-25 10:02:17 +02:00
Marcus Holl
b7ea5e8f66
add scripts (sh, groovy) for generating docu
2018-10-16 15:44:41 +02:00
