Skip to content

Commit

Permalink
Adjust the structure of '@description' (#498)
Browse files Browse the repository at this point in the history
Working on #498 revealed that the "Description" annotation consists of
one line always. This helps to parse the generated flux-commands.md.
  • Loading branch information
dr0i committed Oct 21, 2024
1 parent 71c367c commit 14c81a0
Showing 1 changed file with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@
* @author Pascal Christoph
* @author Christoph Böhme
*/
@Description("Writes the xml into the filesystem. The filename is constructed from the xpath given as 'property'.\n" + // checkstyle-disable-line ClassDataAbstractionCoupling|ClassFanOutComplexity
" Variables are\n" + "- 'target' (determining the output directory)\n" +
"- 'property' (the element in the XML entity. Constitutes the main part of the file's name.)\n" +
"- 'startIndex' ( a subfolder will be extracted out of the filename. This marks the index' beginning )\n" +
"- 'stopIndex' ( a subfolder will be extracted out of the filename. This marks the index' end )\n")
@Description("Writes the XML into the filesystem. The filename is constructed from the XPATH given as 'property'." + // checkstyle-disable-line ClassDataAbstractionCoupling|ClassFanOutComplexity
" Variables are:" + "`target` (determining the output directory)" +
", `property` (the element in the XML entity. Constitutes the main part of the file's name.)" +
", `startIndex` ( a subfolder will be extracted out of the filename. This marks the index' beginning )" +
", `stopIndex` ( a subfolder will be extracted out of the filename. This marks the index' end )")
@In(StreamReceiver.class)
@Out(Void.class)
@FluxCommand("write-xml-files")
Expand Down

0 comments on commit 14c81a0

Please sign in to comment.