Add missing API Config javadocs

2023-07-03 06:50:12 -05:00
parent ea40006023
commit b50c2cf9a9
6 changed files with 15 additions and 16 deletions
@@ -27,7 +27,7 @@ import com.seibel.distanthorizons.api.interfaces.config.IDhApiConfigGroup;
 /**
 * Distant Horizons' world generation configuration. <br><br>
 *
- * Note: Fake chunks are NOT saved in Minecraft's vanilla save system.
+ * Note: Chunks generated via DH's world generator are NOT saved in Minecraft's vanilla save system.
 *
 * @author James Seibel
 * @version 2022-9-15
@@ -36,16 +36,17 @@ public interface IDhApiWorldGenerationConfig extends IDhApiConfigGroup
 {
 	
 	/**
-	 * Defines whether fake chunks will be generated
+	 * Defines whether LOD chunks will be generated
 	 * outside Minecraft's vanilla render distance.
 	 */
 	IDhApiConfigValue<Boolean> enableDistantWorldGeneration();
 	
-	/** Defines to what level fake chunks will be generated. */
+	/** Defines to what level LOD chunks will be generated. */
 	IDhApiConfigValue<EDhApiDistantGeneratorMode> distantGeneratorMode();
 	
 	/** 
-	 * TODO
+	 * Defines what lighting engine will be used when
+	 * Distant Horizons generates chunks.
 	 */
 	IDhApiConfigValue<ELightGenerationMode> lightingEngine();
 	
@@ -37,13 +37,13 @@ public interface IDhApiDebuggingConfig extends IDhApiConfigGroup
 	/** If enabled debug keybindings can be used. */
 	IDhApiConfigValue<Boolean> debugKeybindings();
 	
-	/** TODO */
+	/** If enabled all LODs will be rendered as wireframe. */
 	IDhApiConfigValue<Boolean> renderWireframe();
 	
-	/** TODO */
+	/** If enabled Distant Horizons will attempt to disable Minecraft's block rendering so only LODs will render. */
 	IDhApiConfigValue<Boolean> lodOnlyMode();
 	
-	/** TODO */
+	/** If enabled Distant Horizons' debug wireframe rendering will be enabled. */
 	IDhApiConfigValue<Boolean> debugWireframeRendering();
 	
 	
@@ -96,7 +96,7 @@ public interface IDhApiGraphicsConfig extends IDhApiConfigGroup
 	 */
 	IDhApiConfigValue<Boolean> tintWithAvoidedBlocks();
 	
-	/**
+	/*
 	 * The same as vanilla Minecraft's biome blending. <br><br>
 	 *
 	 * 0 = blending of 1x1 aka off	<br>
@@ -144,8 +144,9 @@ public interface IDhApiGraphicsConfig extends IDhApiConfigGroup
 	/** If enabled vanilla chunk rendering is disabled and only fake chunks are rendered. */
 	IDhApiConfigValue<Boolean> lodOnlyMode();
 	
-	/**
-	 * TODO
+	/** 
+	 * Setting this to a non-zero number will modify vanilla Minecraft's LOD Bias, 
+	 * increasing how quickly its textures fade away.  
 	 */
 	IDhApiConfigValue<Double> lodBias();
 	
@@ -22,7 +22,7 @@ package com.seibel.distanthorizons.api.interfaces.config.client;
 import com.seibel.distanthorizons.api.interfaces.config.IDhApiConfigGroup;

 /**
- * Distant Horizons' fog configuration. <br><br>
+ * Distant Horizons' logging configuration. <br><br>
 *
 * @author James Seibel
 * @version 2022-6-14
@@ -54,9 +54,7 @@ public interface IDhApiMultiThreadingConfig extends IDhApiConfigGroup
 	 */
 	IDhApiConfigValue<Integer> dataConverterThreads();
 	
-	/**
-	 * TODO
-	 */
+	/** Defines how many threads should be used to convert Minecraft chunks to LOD data. */
 	IDhApiConfigValue<Integer> chunkLodConverterThreads();
 	
 }
@@ -42,12 +42,11 @@ public interface IDhApiMultiplayerConfig extends IDhApiConfigGroup
 	 * Defines the necessary similarity (as a percent) that two potential levels
 	 * need in order to be considered the same. <br> <br>
 	 *
-	 * Setting this to zero causes every level of a specific dimension type to be consider
+	 * Setting this to zero causes every level of a specific dimension type to be considered
 	 * the same level. <br>
 	 * Setting this to a non-zero value allows for usage in servers that user Multiverse
 	 * or similar mods.
 	 */
 	IDhApiConfigValue<Double> multiverseSimilarityRequirement();
 	
-	
 }