From 14c81a0fdb489fe632febfc49b823e05b2ee619f Mon Sep 17 00:00:00 2001 From: Pascal Christoph Date: Mon, 21 Oct 2024 13:14:03 +0200 Subject: [PATCH] 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. --- .../java/org/metafacture/xml/XmlFilenameWriter.java | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/metafacture-xml/src/main/java/org/metafacture/xml/XmlFilenameWriter.java b/metafacture-xml/src/main/java/org/metafacture/xml/XmlFilenameWriter.java index 77ed89d2e..f2bf6ff06 100644 --- a/metafacture-xml/src/main/java/org/metafacture/xml/XmlFilenameWriter.java +++ b/metafacture-xml/src/main/java/org/metafacture/xml/XmlFilenameWriter.java @@ -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")