From 11d1683b48f78c4dd4e9117fa132180a69e6fb17 Mon Sep 17 00:00:00 2001 From: yoyosource Date: Thu, 29 Apr 2021 11:25:44 +0200 Subject: [PATCH] Add ConfigConverter JavaDoc --- .../steamwar/bausystem/configplayer/ConfigConverter.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/BauSystem_Main/src/de/steamwar/bausystem/configplayer/ConfigConverter.java b/BauSystem_Main/src/de/steamwar/bausystem/configplayer/ConfigConverter.java index 29b6314c..bf9f1fdf 100644 --- a/BauSystem_Main/src/de/steamwar/bausystem/configplayer/ConfigConverter.java +++ b/BauSystem_Main/src/de/steamwar/bausystem/configplayer/ConfigConverter.java @@ -2,6 +2,14 @@ package de.steamwar.bausystem.configplayer; import yapion.hierarchy.types.YAPIONObject; +/** + * A new {@link ConfigConverter} should be written when you remove anything + * from the Config or modify any mayor part. When you move anything from + * any key to any other key you should write a new {@link ConfigConverter}. + * For adding any new key you should be able to get the default without + * having it in the Config. Anything you need to change you should also + * change the {@link ConfigCreator} accordingly, to produce the new Config. + */ public interface ConfigConverter { /**