From e9ed8085ac7a808d7ad83b4b7e1d6be8a41a6c94 Mon Sep 17 00:00:00 2001
From: Michael Williamson <mike@zwobble.org>
Date: Fri, 25 Mar 2016 11:18:51 +0000
Subject: Add Javadoc to Result

---
 src/main/java/org/zwobble/mammoth/Result.java | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/main/java/org/zwobble/mammoth/Result.java b/src/main/java/org/zwobble/mammoth/Result.java
index 1c09559..3cc8f24 100644
--- a/src/main/java/org/zwobble/mammoth/Result.java
+++ b/src/main/java/org/zwobble/mammoth/Result.java
@@ -2,7 +2,17 @@ package org.zwobble.mammoth;
 
 import java.util.Set;
 
+/**
+ * The result of converting a document.
+ */
 public interface Result<T> {
+    /**
+     * The generated value.
+     */
     T getValue();
+
+    /**
+     * Any warnings generated during the conversion.
+     */
     Set<String> getWarnings();
 }
-- 
cgit v1.2.3