Comments fix

A. Apesteguia · A. Apesteguia · commit 2ee234ac7939 · 2020-12-02T19:05:10.000+01:00
diff --git a/src/main/java/com/codepressed/CSVtoXML/Main.java b/src/main/java/com/codepressed/CSVtoXML/Main.java
@@ -40,11 +40,8 @@ public static void main(String[] args) {
             }
 
                 try {
-                    //ArrayList of ArrayStrings Generation with CSV
                     ArrayList<String[]> elements;
                     elements = new Reader().CSVtoArrayList(csvFile, csvSplit);
-
-                    //XML Doc Generation with ArrayList
                     Document xmlDoc;
                     xmlDoc = new XMLDoc().docBuilder(elements, elementName);
                     XMLTransformer.transformDocToFile(xmlDoc, xmlFile);
diff --git a/src/main/java/com/codepressed/CSVtoXML/Reader.java b/src/main/java/com/codepressed/CSVtoXML/Reader.java
@@ -6,7 +6,13 @@
 
 public class Reader {
 
-    //ArrayList Generation ArrayStrings  with the CSV Data
+    /**
+     *
+     * @param csvFile Input file
+     * @param csvSplit Invalid chars filter
+     * @return ArrayList of CSV Values
+     * @throws IOException
+     */
     public ArrayList<String[]> CSVtoArrayList(String csvFile, String csvSplit) throws IOException {
         ArrayList<String[]> elements = new ArrayList<String[]>();
         BufferedReader csvReader = null;
diff --git a/src/main/java/com/codepressed/CSVtoXML/XMLDoc.java b/src/main/java/com/codepressed/CSVtoXML/XMLDoc.java
@@ -12,7 +12,13 @@
 
 public class XMLDoc {
 
-    //DOC Generation -> XML with ArrayList String elements
+    /**
+     *
+     * @param XMLelements ArrayList of CSV Values
+     * @param elementName Name fixed for node tree
+     * @return Final doc
+     * @throws ParserConfigurationException
+     */
     public Document docBuilder(ArrayList<String[]> XMLelements, String elementName) throws ParserConfigurationException {
         if (elementName == null){
             elementName = "element";
diff --git a/src/main/java/com/codepressed/CSVtoXML/XMLTransformer.java b/src/main/java/com/codepressed/CSVtoXML/XMLTransformer.java
@@ -13,7 +13,11 @@
 import java.io.FileOutputStream;
 
 public class XMLTransformer {
-    //XML Generation -> Transform DOC Data to XML Format
+    /** Transforms DOC Data to XML Format
+     * @param xmlDoc
+     * @param xmlFile
+     * @throws TransformerException
+     */
     public static void transformDocToFile(Document xmlDoc, String xmlFile) throws TransformerException {
         TransformerFactory xmlTransformerFactory = TransformerFactory.newInstance();
         Transformer xmlTransformer = xmlTransformerFactory.newTransformer();
