Add Javadoc to Result

1 files changed, 10 insertions, 0 deletions

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();
 }