From e12d8ec4666cc80fb77a869457b34ee6c98a62d6 Mon Sep 17 00:00:00 2001
From: Hugo Kerstens <hugokk@hotmail.nl>
Date: Tue, 22 Mar 2016 17:17:13 +0100
Subject: [PATCH] Add descriptions for the new Config API

---
 .../ViaVersion/api/ViaVersionConfig.java      | 49 +++++++++++++++++--
 1 file changed, 46 insertions(+), 3 deletions(-)

diff --git a/src/main/java/us/myles/ViaVersion/api/ViaVersionConfig.java b/src/main/java/us/myles/ViaVersion/api/ViaVersionConfig.java
index 37e4aa5c1..97b8f85c5 100644
--- a/src/main/java/us/myles/ViaVersion/api/ViaVersionConfig.java
+++ b/src/main/java/us/myles/ViaVersion/api/ViaVersionConfig.java
@@ -1,8 +1,5 @@
 package us.myles.ViaVersion.api;
 
-/**
- * Created by Hugo on 22/03/2016.
- */
 public interface ViaVersionConfig {
 
     /**
@@ -19,21 +16,67 @@ public interface ViaVersionConfig {
      */
     boolean isPreventCollision();
 
+    /**
+     * Obtain if 1.9 clients are shown the new effect indicator in the top-right corner
+     *
+     * @return true if the using of the new effect indicator is enabled
+     */
     boolean isNewEffectIndicator();
 
+    /**
+     * Obtain if metadata errors will be suppressed
+     *
+     * @return true if metadata errors suppression is enabled
+     */
     boolean isSuppressMetadataErrors();
 
+    /**
+     * Obtain if blocking in 1.9 appears as a player holding a shield
+     *
+     * @return true if shield blocking is enabled
+     */
     boolean isShieldBlocking();
 
+    /**
+     * Obtain if armor stand positions are fixed so holograms show up at the correct height in 1.9
+     *
+     * @return true if hologram patching is enabled
+     */
     boolean isHologramPatch();
 
+    /**
+     * Obtain if boss bars are fixed for 1.9 clients
+     *
+     * @return true if boss bar patching is enabled
+     */
     boolean isBossbarPatch();
 
+    /**
+     * Obtain if the boss bars for 1.9 clients are being stopped from flickering
+     * This will keep all boss bars on 100% (not recommended)
+     *
+     * @return true if boss bar anti flickering is enabled
+     */
     boolean isBossbarAntiflicker();
 
+    /**
+     * Obtain if unknown entity errors will be suppressed
+     *
+     * @return true if boss bar patching is enabled
+     */
     boolean isUnknownEntitiesSuppressed();
 
+    /**
+     * Obtain the vertical offset armor stands are being moved with when the hologram patch is enabled
+     *
+     * @return the vertical offset holograms will be moved with
+     */
     double getHologramYOffset();
 
+    /**
+     * Obtain if players will be automatically put in the same team when collision preventing is enabled
+     *
+     * @return true if automatic teaming is enabled
+     */
     boolean isAutoTeam();
 }