From 946cab444bc301d8a7c756a1bab039558288de89 Mon Sep 17 00:00:00 2001
From: "Benjamin J. Culkin" <bjculkin@mix.wvu.edu>
Date: Wed, 11 Oct 2017 13:41:07 -0300
Subject: Cleanup work

---
 .../java/bjc/utils/data/internals/WrappedOption.java    | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'base/src/main/java/bjc/utils/data/internals/WrappedOption.java')

diff --git a/base/src/main/java/bjc/utils/data/internals/WrappedOption.java b/base/src/main/java/bjc/utils/data/internals/WrappedOption.java
index 512c699..872295f 100644
--- a/base/src/main/java/bjc/utils/data/internals/WrappedOption.java
+++ b/base/src/main/java/bjc/utils/data/internals/WrappedOption.java
@@ -6,13 +6,30 @@ import java.util.function.UnaryOperator;
 import bjc.utils.data.IHolder;
 import bjc.utils.data.Option;
 
+/**
+ * A wrapped optional value.
+ *
+ * @author Ben Culkin.
+ */
 public class WrappedOption<ContainedType> implements IHolder<ContainedType> {
+	/* The held value. */
 	private final IHolder<IHolder<ContainedType>> held;
 
+	/**
+	 * Create a new wrapped option.
+	 *
+	 * @param seedValue
+	 * 	The value to wrap.
+	 */
 	public WrappedOption(final IHolder<ContainedType> seedValue) {
 		held = new Option<>(seedValue);
 	}
 
+	/*
+	 * The dummy parameter is to ensure the compiler can pick the right
+	 * method, because without this method erases to the same type as the
+	 * public one.
+	 */
 	private WrappedOption(final IHolder<IHolder<ContainedType>> toHold, final boolean dummy) {
 		held = toHold;
 	}
-- 
cgit v1.2.3