Fix javadoc for module "xml" (#396)

Author: dr0i

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

@@ -44,6 +44,8 @@ public final class GenericXmlHandler extends DefaultXmlPipe<StreamReceiver> {
 
     private static final Pattern TABS = Pattern.compile("\t+");
 
+    private static final String METAMORPH_RECORD_TAG = "org.culturegraph.metamorph.xml.recordtag";
+
     private String attributeMarker = DEFAULT_ATTRIBUTE_MARKER;
     private String recordTagName = DEFAULT_RECORD_TAG;
     private String valueTagName = DEFAULT_VALUE_TAG;
@@ -53,8 +55,12 @@ public final class GenericXmlHandler extends DefaultXmlPipe<StreamReceiver> {
 
     private boolean emitNamespace = EMIT_NAMESPACE;
 
+    /**
+     * Constructs a GenericXmlHandler by loading the system property
+     * {@value #METAMORPH_RECORD_TAG} if that system property was set.
+     */
     public GenericXmlHandler() {
-        final String recordTagNameProperty = System.getProperty("org.culturegraph.metamorph.xml.recordtag");
+        final String recordTagNameProperty = System.getProperty(METAMORPH_RECORD_TAG);
         if (recordTagNameProperty != null) {
             recordTagName = recordTagNameProperty;
         }

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

@@ -105,6 +105,11 @@ public String getValueTag() {
         return valueTag;
     }
 
+    /**
+     * Loads namespaces from a file.
+     *
+     * @param file the name of the file to load the namespace properties from
+     */
     public void setNamespaceFile(final String file) {
         final Properties properties;
         try {
@@ -118,6 +123,11 @@ public void setNamespaceFile(final String file) {
         }
     }
 
+    /**
+     * Loads namespaces from a URL.
+     *
+     * @param url the URL to load the namespace properties from.
+     */
     public void setNamespaceFile(final URL url) {
         final Properties properties;
         try {

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

@@ -50,6 +50,10 @@ public final class XmlDecoder extends DefaultObjectPipe<Reader, XmlReceiver> {
 
     private final XMLReader saxReader;
 
+    /**
+     * Constructs an XmlDecoder by obtaining a new instance of a {@link
+     * org.xml.sax.XMLReader}.
+     */
     public XmlDecoder() {
         try {
             saxReader = XMLReaderFactory.createXMLReader();