Skip to content

Commit 14c81a0

Browse files
committed
Adjust the structure of '@description' (#498)
Working on #498 revealed that the "Description" annotation consists of one line always. This helps to parse the generated flux-commands.md.
1 parent 71c367c commit 14c81a0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

metafacture-xml/src/main/java/org/metafacture/xml/XmlFilenameWriter.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@
5151
* @author Pascal Christoph
5252
* @author Christoph Böhme
5353
*/
54-
@Description("Writes the xml into the filesystem. The filename is constructed from the xpath given as 'property'.\n" + // checkstyle-disable-line ClassDataAbstractionCoupling|ClassFanOutComplexity
55-
" Variables are\n" + "- 'target' (determining the output directory)\n" +
56-
"- 'property' (the element in the XML entity. Constitutes the main part of the file's name.)\n" +
57-
"- 'startIndex' ( a subfolder will be extracted out of the filename. This marks the index' beginning )\n" +
58-
"- 'stopIndex' ( a subfolder will be extracted out of the filename. This marks the index' end )\n")
54+
@Description("Writes the XML into the filesystem. The filename is constructed from the XPATH given as 'property'." + // checkstyle-disable-line ClassDataAbstractionCoupling|ClassFanOutComplexity
55+
" Variables are:" + "`target` (determining the output directory)" +
56+
", `property` (the element in the XML entity. Constitutes the main part of the file's name.)" +
57+
", `startIndex` ( a subfolder will be extracted out of the filename. This marks the index' beginning )" +
58+
", `stopIndex` ( a subfolder will be extracted out of the filename. This marks the index' end )")
5959
@In(StreamReceiver.class)
6060
@Out(Void.class)
6161
@FluxCommand("write-xml-files")

0 commit comments

Comments
 (0)