From a966676c629f7f14fcbba82a9ada5e2cbeca8314 Mon Sep 17 00:00:00 2001
From: Adrien Hopkins <masterofnumbers17@gmail.com>
Date: Tue, 26 Nov 2019 15:20:04 -0500
Subject: Updated the documentation of existing classes.

---
 src/org/unitConverter/math/ObjectProduct.java | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/org/unitConverter/math')

diff --git a/src/org/unitConverter/math/ObjectProduct.java b/src/org/unitConverter/math/ObjectProduct.java
index 0cf89ec..29d0f6e 100644
--- a/src/org/unitConverter/math/ObjectProduct.java
+++ b/src/org/unitConverter/math/ObjectProduct.java
@@ -238,6 +238,14 @@ public final class ObjectProduct<T> {
 		return new ObjectProduct<>(map);
 	}
 
+	/**
+	 * Converts this product to a string using the objects' {@link Object#toString()} method. If objects have a long
+	 * toString representation, it is recommended to use {@link #toString(Function)} instead to shorten the returned
+	 * string.
+	 * 
+	 * <p>
+	 * {@inheritDoc}
+	 */
 	@Override
 	public String toString() {
 		return this.toString(Object::toString);
-- 
cgit v1.2.3