Added some JavaDoc explanations to the classes

core/src/main/java/io/github/dre2n/dungeonsxl/DungeonsXL.java

@@ -58,6 +58,9 @@
 import org.bukkit.scheduler.BukkitTask;
 
 /**
+ * The main class of DungeonsXL.
+ * It contains several important instances and the actions when the plugin is enabled / disabled.
+ *
  * @author Frank Baumann, Tobias Schmitz, Daniel Saukel
  */
 public class DungeonsXL extends BRPlugin {

core/src/main/java/io/github/dre2n/dungeonsxl/announcer/Announcer.java

@@ -44,6 +44,8 @@
 import org.bukkit.inventory.meta.ItemMeta;
 
 /**
+ * Represents a game announcement.
+ *
  * @author Daniel Saukel
  */
 public class Announcer {

core/src/main/java/io/github/dre2n/dungeonsxl/announcer/Announcers.java

@@ -24,6 +24,8 @@
 import org.bukkit.inventory.Inventory;
 
 /**
+ * Announcer instance manager.
+ *
  * @author Daniel Saukel
  */
 public class Announcers {

core/src/main/java/io/github/dre2n/dungeonsxl/command/DeletePortalCommand.java

@@ -28,8 +28,9 @@
 
 /**
  * @author Frank Baumann, Daniel Saukel
- * @deprecated
+ * @deprecated Use BreakCommand instead.
  */
+@Deprecated
 public class DeletePortalCommand extends BRCommand {
 
     DungeonsXL plugin = DungeonsXL.getInstance();

core/src/main/java/io/github/dre2n/dungeonsxl/config/DMessages.java

@@ -24,6 +24,9 @@
 import org.bukkit.configuration.file.YamlConfiguration;
 
 /**
+ * An enumeration of all messages.
+ * The values are fetched from the language file.
+ *
  * @author Daniel Saukel
  */
 public enum DMessages implements Messages {

core/src/main/java/io/github/dre2n/dungeonsxl/config/DungeonConfig.java

@@ -25,6 +25,8 @@
 import java.util.List;
 
 /**
+ * Represents a dungeon script. See {@link io.github.dre2n.dungeonsxl.dungeon.Dungeon}.
+ *
  * @author Daniel Saukel
  */
 public class DungeonConfig extends BRConfig {

core/src/main/java/io/github/dre2n/dungeonsxl/config/GlobalData.java

@@ -20,6 +20,8 @@
 import java.io.File;
 
 /**
+ * Represents the global data.yml.
+ *
  * @author Daniel Saukel
  */
 public class GlobalData extends BRConfig {

core/src/main/java/io/github/dre2n/dungeonsxl/config/MainConfig.java

@@ -32,6 +32,8 @@
 import org.bukkit.configuration.ConfigurationSection;
 
 /**
+ * Represents the main config.yml.
+ *
  * @author Frank Baumann, Milan Albrecht, Daniel Saukel
  */
 public class MainConfig extends BRConfig {

core/src/main/java/io/github/dre2n/dungeonsxl/config/PlayerData.java

@@ -35,6 +35,8 @@
 import org.bukkit.potion.PotionEffect;
 
 /**
+ * Represents a player's persistent data.
+ *
  * @author Daniel Saukel
  */
 public class PlayerData extends BRConfig {

core/src/main/java/io/github/dre2n/dungeonsxl/config/SignData.java

@@ -30,6 +30,8 @@
 import org.bukkit.block.Sign;
 
 /**
+ * Represents the data file of a dungeon map, mainly to store signs.
+ *
  * @author Daniel Saukel
  */
 public class SignData {

core/src/main/java/io/github/dre2n/dungeonsxl/config/WorldConfig.java

@@ -44,6 +44,10 @@
 import org.bukkit.inventory.ItemStack;
 
 /**
+ * The world configuration is a simple game rule source.
+ * Besides game rules, WorldConfig also stores some map specific data such as the invited players.
+ * It is used directly in dungeon map config.yml files, but also part of dungeon and main config files.
+ *
  * @author Frank Baumann, Milan Albrecht, Daniel Saukel
  */
 public class WorldConfig extends GameRules {

core/src/main/java/io/github/dre2n/dungeonsxl/dungeon/Dungeon.java

@@ -21,6 +21,10 @@
 import java.io.File;
 
 /**
+ * Represents a dungeon.
+ * While multi floor dungeon scripts are represented by {@link io.github.dre2n.dungeonsxl.config.DungeonConfig},
+ * single floor dungeons also get a dungeon object without a config file as a placeholder.
+ *
  * @author Daniel Saukel
  */
 public class Dungeon {

core/src/main/java/io/github/dre2n/dungeonsxl/dungeon/Dungeons.java

@@ -22,6 +22,8 @@
 import java.util.List;
 
 /**
+ * Dungeon instance manager.
+ *
  * @author Daniel Saukel
  */
 public class Dungeons {

core/src/main/java/io/github/dre2n/dungeonsxl/game/Game.java

@@ -41,6 +41,9 @@
 import org.bukkit.scheduler.BukkitRunnable;
 
 /**
+ * Game mostly stores for which purposes and how a {@link io.github.dre2n.dungeonsxl.dungeon.Dungeon} is used,
+ * the player groups and the progress.
+ *
  * @author Daniel Saukel
  */
 public class Game {

core/src/main/java/io/github/dre2n/dungeonsxl/game/GameGoal.java

@@ -17,6 +17,8 @@
 package io.github.dre2n.dungeonsxl.game;
 
 /**
+ * A game goal defines what the players have to do in order to finish the game.
+ *
  * @author Daniel Saukel
  */
 public enum GameGoal {

core/src/main/java/io/github/dre2n/dungeonsxl/game/GameRules.java

@@ -29,6 +29,8 @@
 import org.bukkit.inventory.ItemStack;
 
 /**
+ * See {@link io.github.dre2n.dungeonsxl.config.WorldConfig}
+ *
  * @author Daniel Saukel
  */
 public class GameRules {

core/src/main/java/io/github/dre2n/dungeonsxl/game/GameType.java

@@ -19,6 +19,8 @@
 import org.bukkit.GameMode;
 
 /**
+ * Implement this to create custom game types.
+ *
  * @author Daniel Saukel
  */
 public interface GameType {

core/src/main/java/io/github/dre2n/dungeonsxl/game/GameTypeDefault.java

@@ -20,6 +20,8 @@
 import org.bukkit.GameMode;
 
 /**
+ * Default implementation of {@link io.github.dre2n.dungeonsxl.game.GameType}.
+ *
  * @author Daniel Saukel
  */
 public enum GameTypeDefault implements GameType {

core/src/main/java/io/github/dre2n/dungeonsxl/game/GameTypes.java

@@ -22,6 +22,8 @@
 import java.util.List;
 
 /**
+ * GameType instance manager.
+ *
  * @author Daniel Saukel
  */
 public class GameTypes {

core/src/main/java/io/github/dre2n/dungeonsxl/global/DPortal.java

@@ -35,6 +35,8 @@
 import org.bukkit.entity.Player;
 
 /**
+ * A portal that leads into a dungeon.
+ *
  * @author Frank Baumann, Daniel Saukel
  */
 public class DPortal extends GlobalProtection {

core/src/main/java/io/github/dre2n/dungeonsxl/global/GameSign.java

@@ -34,6 +34,8 @@
 import org.bukkit.entity.Player;
 
 /**
+ * Basically a GroupSign, but to form a game of multiple groups.
+ *
  * @author Frank Baumann, Milan Albrecht, Daniel Saukel
  */
 public class GameSign extends GlobalProtection {

core/src/main/java/io/github/dre2n/dungeonsxl/global/GlobalProtection.java

@@ -1,7 +1,18 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ * Copyright (C) 2012-2016 Frank Baumann
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 package io.github.dre2n.dungeonsxl.global;
 

core/src/main/java/io/github/dre2n/dungeonsxl/global/GlobalProtections.java

@@ -1,7 +1,18 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ * Copyright (C) 2012-2016 Frank Baumann
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 package io.github.dre2n.dungeonsxl.global;
 

core/src/main/java/io/github/dre2n/dungeonsxl/global/GroupSign.java

@@ -33,6 +33,8 @@
 import org.bukkit.entity.Player;
 
 /**
+ * A sign to form a group and to define its dungeon.
+ *
  * @author Frank Baumann, Milan Albrecht, Daniel Saukel
  */
 public class GroupSign extends GlobalProtection {

core/src/main/java/io/github/dre2n/dungeonsxl/global/LeaveSign.java

@@ -30,6 +30,8 @@
 import org.bukkit.entity.Player;
 
 /**
+ * A sign to leave a group.
+ *
  * @author Frank Baumann
  */
 public class LeaveSign extends GlobalProtection {

core/src/main/java/io/github/dre2n/dungeonsxl/loottable/DLootTable.java

@@ -26,6 +26,8 @@
 import org.bukkit.inventory.ItemStack;
 
 /**
+ * A loot table for rewards and mob drops.
+ *
  * @author Daniel Saukel
  */
 public class DLootTable {

core/src/main/java/io/github/dre2n/dungeonsxl/loottable/DLootTables.java

@@ -22,6 +22,8 @@
 import java.util.List;
 
 /**
+ * DLootTable instance manager.
+ *
  * @author Daniel Saukel
  */
 public class DLootTables {

core/src/main/java/io/github/dre2n/dungeonsxl/mob/CitizensMobProvider.java

@@ -26,6 +26,8 @@
 import org.bukkit.entity.LivingEntity;
 
 /**
+ * ExternalMobProvider implementation for Citizens.
+ *
  * @author Daniel Saukel
  */
 public class CitizensMobProvider implements ExternalMobProvider {

core/src/main/java/io/github/dre2n/dungeonsxl/mob/CustomExternalMobProvider.java

@@ -21,6 +21,8 @@
 import org.bukkit.Location;
 
 /**
+ * A custom external mob provider like defined in the main config file.
+ *
  * @author Daniel Saukel
  */
 public class CustomExternalMobProvider implements ExternalMobProvider {

core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobPlugin.java

@@ -20,6 +20,8 @@
 import org.bukkit.Location;
 
 /**
+ * Officially supported external mob plugins.
+ *
  * @author Daniel Saukel
  */
 public enum ExternalMobPlugin implements ExternalMobProvider {

core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobProvider.java

@@ -19,6 +19,8 @@
 import org.bukkit.Location;
 
 /**
+ * Implement this to create custom ExternalMobProviders.
+ *
  * @author Daniel Saukel
  */
 public interface ExternalMobProvider {

core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobProviders.java

@@ -25,6 +25,8 @@
 import org.bukkit.Bukkit;
 
 /**
+ * ExternalMobProvider instance manager.
+ *
  * @author Daniel Saukel
  */
 public class ExternalMobProviders {

core/src/main/java/io/github/dre2n/dungeonsxl/player/DClass.java

@@ -29,6 +29,8 @@
 import org.bukkit.inventory.ItemStack;
 
 /**
+ * Represents a class and a class script.
+ *
  * @author Frank Baumann, Daniel Saukel
  */
 public class DClass {

core/src/main/java/io/github/dre2n/dungeonsxl/player/DClasses.java

@@ -22,6 +22,8 @@
 import java.util.List;
 
 /**
+ * DClass instance manager.
+ *
  * @author Daniel Saukel
  */
 public class DClasses {

core/src/main/java/io/github/dre2n/dungeonsxl/player/DEditPlayer.java

@@ -33,7 +33,7 @@
 import org.bukkit.event.block.SignChangeEvent;
 
 /**
- * Represents a player in an DEditWorld.
+ * Represents a player in a DEditWorld.
  *
  * @author Daniel Saukel
  */

core/src/main/java/io/github/dre2n/dungeonsxl/player/DGlobalPlayer.java

@@ -34,7 +34,6 @@
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.potion.PotionEffect;
-import org.bukkit.scheduler.BukkitRunnable;
 
 /**
  * Represents a player in the non-DXL worlds of the server.

core/src/main/java/io/github/dre2n/dungeonsxl/player/DGroup.java

@@ -44,6 +44,8 @@
 import org.bukkit.scheduler.BukkitTask;
 
 /**
+ * Represents a group of players.
+ *
  * @author Frank Baumann, Daniel Saukel
  */
 public class DGroup {

core/src/main/java/io/github/dre2n/dungeonsxl/player/DInstancePlayer.java

@@ -21,6 +21,8 @@
 import org.bukkit.potion.PotionEffect;
 
 /**
+ * Represents a player in an instance.
+ *
  * @author Daniel Saukel
  */
 public abstract class DInstancePlayer extends DGlobalPlayer {

core/src/main/java/io/github/dre2n/dungeonsxl/player/DPlayers.java

@@ -23,6 +23,8 @@
 import org.bukkit.entity.Player;
 
 /**
+ * DGlobalPlayer instance manager.
+ *
  * @author Daniel Saukel
  */
 public class DPlayers {

core/src/main/java/io/github/dre2n/dungeonsxl/requirement/Requirement.java

@@ -26,6 +26,8 @@
 import org.bukkit.entity.Player;
 
 /**
+ * Extend this to create a custom Requirement.
+ *
  * @author Daniel Saukel
  */
 public abstract class Requirement {