Docs for Simplifiable

Author: sovdeeth

src/main/java/org/skriptlang/skript/lang/simplification/Simplifiable.java

@@ -4,6 +4,17 @@
 import ch.njol.skript.lang.SyntaxElement;
 import org.bukkit.event.Event;
 
+/**
+ * Represents an object that can be simplified to a simpler {@link SyntaxElement}. For example, a complex math equation
+ * can be simplified to a single number {@link ch.njol.skript.lang.Literal} if all the inputs are
+ * {@link ch.njol.skript.lang.Literal}s.
+ * <br>
+ * Simplification should never invalidate contracts. For example, any simplified expression should take care to return
+ * the same or a more specific type than the original expression, never a more generic type. Likewise, be sure to
+ * maintain the behavior of change() and acceptsChange(). Failure to do so can result in unexpected behavior and
+ * tricky bugs.
+ * @param <S> the type of the simplified object
+ */
 public interface Simplifiable<S extends SyntaxElement> {
 
 	/**