From d3b52cf87409b1d57c144025dff68829a2e182a0 Mon Sep 17 00:00:00 2001
From: Tom Arild Jakobsen <tom@item.no>
Date: Thu, 27 Aug 2015 13:21:17 +0200
Subject: [PATCH] Fixed Javadoc, and README

---
 README.md                                            | 12 ++++++------
 build.gradle                                         |  2 +-
 .../com/nerdforge/unxml/parsers/ArrayParser.java     |  4 +++-
 .../unxml/parsers/builders/ObjectParserBuilder.java  |  6 ++++--
 .../nerdforge/unxml/parsers/ObjectParserTest.java    |  2 +-
 5 files changed, 15 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index fd9eb3d..fa24913 100644
--- a/README.md
+++ b/README.md
@@ -37,11 +37,11 @@ To create a [Parser](src/main/java/com/nerdforge/unxml/parsers/Parser.java) you
 Parsing parsing = ParsingFactory.getInstance().create();
 
 // create parser that will output a Jackson ObjectNode
-Parser parser = parsing.obj().attribute("resultKey", "//my-xpath").build();
-Parser parser2 = parsing.obj("//my-root").attribute("id", "@id").build();
+Parser<ObjectNode> parser = parsing.obj().attribute("resultKey", "//my-xpath").build();
+Parser<ObjectNode> parser2 = parsing.obj("//my-root").attribute("id", "@id").build();
 
 // create parser that will output a Jackson ArrayNode
-Parser parser3 = parsing.arr(parsing.obj().attribute("id", "@id"));
+Parser<ArrayNode> parser3 = parsing.arr(parsing.obj().attribute("id", "@id"));
 ```
 
 ## Example - Parsing an object
@@ -67,12 +67,12 @@ public class MyController {
     Parsing parsing = ParsingFactory.getInstance().create();
     Document document = parsing.xml().document(inputXmlString);
     
-    Parser parser = parsing.obj() // (1)
+    Parser<ObjectNode> parser = parsing.obj() // (1)
       .attribute("id", "/root/id", parsing.with(Integer::parseInt)) // (2)
       .attribute("title", "//title") // (3)
       .build(); // (4)
 
-    JsonNode node = parser.apply(document); // (5)
+    ObjectNode node = parser.apply(document); // (5)
     return node;
   }
 }
@@ -218,7 +218,7 @@ Since a [Parser](src/main/java/com/nerdforge/unxml/parsers/Parser.java) is a [fu
 
 ```java
 Parsing parsing = ParsingFactory.getInstance(namespaces).create(); // (1)
-Parser parser = ... // se below for examples
+Parser parser = ... // se above for examples
 Document document = parsing.xml().document(inputXmlString); // (2)
 
 // Apply to an Optional
diff --git a/build.gradle b/build.gradle
index 51e7877..3f5019a 100644
--- a/build.gradle
+++ b/build.gradle
@@ -7,7 +7,7 @@ targetCompatibility = 1.8
 
 archivesBaseName = "unxml"
 group   = 'com.nerdforge'
-version = '0.7-SNAPSHOT'
+version = '0.8'
 
 repositories {
     mavenLocal()
diff --git a/src/main/java/com/nerdforge/unxml/parsers/ArrayParser.java b/src/main/java/com/nerdforge/unxml/parsers/ArrayParser.java
index 2ad953f..072b007 100644
--- a/src/main/java/com/nerdforge/unxml/parsers/ArrayParser.java
+++ b/src/main/java/com/nerdforge/unxml/parsers/ArrayParser.java
@@ -42,7 +42,9 @@ public ArrayNode apply(Node node) {
 
     /**
      * Returns the parsed result as a List of Objects of class A
-     * @return Result as a List of Objects
+     * @param valueType  The type of class that should be instansiated in the list
+     * @param <A> The Class the ListParser will return a list of.
+     * @return Result as a List of Objects of class A
      */
     public <A> ListParser<A> as(Class<A> valueType){
         return this.<List<A>>andThen(jsonUtil.asList(valueType))::apply;
diff --git a/src/main/java/com/nerdforge/unxml/parsers/builders/ObjectParserBuilder.java b/src/main/java/com/nerdforge/unxml/parsers/builders/ObjectParserBuilder.java
index 804c054..23c61b9 100644
--- a/src/main/java/com/nerdforge/unxml/parsers/builders/ObjectParserBuilder.java
+++ b/src/main/java/com/nerdforge/unxml/parsers/builders/ObjectParserBuilder.java
@@ -95,8 +95,10 @@ public ObjectParser build(){
     }
 
     /**
-     * Returns some Json utility methods
-     * @return An instance of JsonUtil
+     * Uses Jackson to instansiate the ObjectNode as a Java Object of type A.
+     * @param valueType The type of class that should be instansiated
+     * @param <A> The Class the InstanceParser will return
+     * @return A parser that outputs an object of Class A.
      */
     public <A> InstanceParser<A> as(Class<A> valueType) {
         return build().<A>andThen(jsonUtil.as(valueType))::apply;
diff --git a/src/test/java/com/nerdforge/unxml/parsers/ObjectParserTest.java b/src/test/java/com/nerdforge/unxml/parsers/ObjectParserTest.java
index b6d08ab..c83e89e 100644
--- a/src/test/java/com/nerdforge/unxml/parsers/ObjectParserTest.java
+++ b/src/test/java/com/nerdforge/unxml/parsers/ObjectParserTest.java
@@ -35,7 +35,7 @@ public void testParseObject() {
             .attribute("id", "/root/id", parsing.with(Integer::parseInt))
             .attribute("title", "//title");
 
-        ObjectParser parser = builder.build();
+        Parser<ObjectNode> parser = builder.build();
         JsonNode node = parser.apply(input);
 
         assertThat(node.get("id").asInt()).isEqualTo(1);