497-improve-xml-documentation

[TobiasNx]

Resolves #497

We decided to improve the documentation.

[dr0i]

See suggestions.

[blackwinter]

There's no space between text chunks (+).

[TobiasNx]

There's no space between text chunks (+).

I am not sure that I understand what I should do. But " +[linebreak] seems to be the usual way how it is formatted in metafacture core: e.g.:
https://github.com/metafacture/metafacture-core/blob/497-improve-decode-xml-documentation/metafacture-json/src/test/java/org/metafacture/json/JsonEncoderTest.java#L268-L275
https://github.com/metafacture/metafacture-core/blob/497-improve-decode-xml-documentation/metafacture-xml/src/main/java/org/metafacture/xml/XmlFilenameWriter.java#L54-L58

[blackwinter]

You're concatenating strings without adding any whitespace between them. "a" + "b" yields "ab", you want "a " + "b" instead.

You chose unfortunate examples, here's a better one.

[TobiasNx]

Thanks done!

[blackwinter]

For future reference: You can inspect the resulting documentation with ./gradlew fluxCommands.