Skip to content

497-improve-xml-documentation #563

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dr0i merged 4 commits into from
Oct 17, 2024
Merged

497-improve-xml-documentation #563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be6e802
Improve handle-generic-xml documentation #497
TobiasNx Oct 9, 2024
e6a86b4
Improve documentation for encode-xml. #497
TobiasNx Oct 9, 2024
c69e894
Apply suggestions from code review
TobiasNx Oct 17, 2024
32741b7
Add whitespaces in Description
TobiasNx Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion metafacture-xml/src/main/java/org/metafacture/xml/GenericXmlHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
2 changes: 1 addition & 1 deletion metafacture-xml/src/main/java/org/metafacture/xml/SimpleXmlEncoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
Loading