Merge #563 from branch '497-improve-decode-xml-documentation' of gith…

…ub.com:metafacture/metafacture-core
metafacture · Oct 17, 2024 · 71c367c · 71c367c
2 parents bdb93ad + 32741b7
commit 71c367c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/metafacture-xml/src/main/java/org/metafacture/xml/GenericXmlHandler.java b/metafacture-xml/src/main/java/org/metafacture/xml/GenericXmlHandler.java
@@ -34,7 +34,11 @@
  * @author Markus Michael Geipel
  *
  */
-@Description("A generic xml reader")
+@Description("A generic XML reader. Separates XML data in distinct records with the defined record tag name (default: `recordtagname=\"record\"`) " +
+        "If no matching record tag is found, the output will be empty. " +
+        "The handler breaks down XML elements with simple string values and optional attributes " +
+        "into entities with a value subfield (name configurable) and additional subfields for each attribute. " +
+        "Record tag and value tag names can be configured. Attributes can get an attributeMarker.")
 @In(XmlReceiver.class)
 @Out(StreamReceiver.class)
 @FluxCommand("handle-generic-xml")

diff --git a/metafacture-xml/src/main/java/org/metafacture/xml/SimpleXmlEncoder.java b/metafacture-xml/src/main/java/org/metafacture/xml/SimpleXmlEncoder.java
@@ -47,7 +47,7 @@
  * @author Christoph Böhme
  *
  */
-@Description("Encodes a stream as xml")
+@Description("Encodes a stream as XML. Defaults: `rootTag=\"records\"`, `recordTag=\"record\"`, no attributeMarker.")
 @In(StreamReceiver.class)
 @Out(String.class)
 @FluxCommand("stream-to-xml")