[CI skip] Added package docs [javadocs]

pom.xml

@@ -44,6 +44,17 @@
         <finalName>${project.name} v${project.version}</finalName>
         
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.1</version>
+                <configuration>
+                    <excludes>
+                        <exclude>**/package-info.java</exclude>
+                    </excludes>
+                </configuration>
+            </plugin>
+            
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>

src/main/java/io/github/thebusybiscuit/slimefun4/api/events/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * This package contains all extensions of {@link org.bukkit.event.Event} that Slimefun provides
+ * and allows you to listen to.
+ */
+package io.github.thebusybiscuit.slimefun4.api.events;

src/main/java/io/github/thebusybiscuit/slimefun4/api/exceptions/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * This package contains all different extensions of {@link java.lang.Exception} that Slimefun
+ * uses internally.
+ */
+package io.github.thebusybiscuit.slimefun4.api.exceptions;

src/main/java/io/github/thebusybiscuit/slimefun4/api/network/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * This package provides the API infrastructure for networks, such as the Cargo- or Energy net.
+ */
+package io.github.thebusybiscuit.slimefun4.api.network;

src/main/java/io/github/thebusybiscuit/slimefun4/api/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * This package contains a bunch of classes and sub-packages related to the interaction
+ * with Slimefun via an API.
+ */
+package io.github.thebusybiscuit.slimefun4.api;

src/main/java/io/github/thebusybiscuit/slimefun4/core/attributes/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * This package contains all variations of {@link io.github.thebusybiscuit.slimefun4.core.attributes.ItemAttribute} that
+ * can be assigned to a {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
+ */
+package io.github.thebusybiscuit.slimefun4.core.attributes;

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * This package contains everything related to slimefun's ingame command.
+ */
+package io.github.thebusybiscuit.slimefun4.core.commands;

src/main/java/io/github/thebusybiscuit/slimefun4/core/guide/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * This package contains the core system for the {@link io.github.thebusybiscuit.slimefun4.core.guide.SlimefunGuide}.
+ * Note that you can find the individual implementations of the guide, in the implementation package
+ */
+package io.github.thebusybiscuit.slimefun4.core.guide;

src/main/java/io/github/thebusybiscuit/slimefun4/core/services/github/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * This package contains everything related to GitHub and contributors.
+ */
+package io.github.thebusybiscuit.slimefun4.core.services.github;

src/main/java/io/github/thebusybiscuit/slimefun4/core/services/metrics/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * This package contains everything related to bStats Metrics
+ */
+package io.github.thebusybiscuit.slimefun4.core.services.metrics;

src/main/java/io/github/thebusybiscuit/slimefun4/core/services/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * This package provides a few "Services" that Slimefun uses.
+ * These services can be considered like a black box, you put stuff in or just let them run,
+ * they work independently.
+ */
+package io.github.thebusybiscuit.slimefun4.core.services;

src/main/java/io/github/thebusybiscuit/slimefun4/core/services/plugins/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * This package contains all hooks to external plugins
+ */
+package io.github.thebusybiscuit.slimefun4.core.services.plugins;

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/guide/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * This package provides the different implementations of our
+ * {@link io.github.thebusybiscuit.slimefun4.core.guide.SlimefunGuide}
+ */
+package io.github.thebusybiscuit.slimefun4.implementation.guide;

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/items/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * This package contains the different classes for each
+ * {@link me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem}
+ */
+package io.github.thebusybiscuit.slimefun4.implementation.items;

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/listeners/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * This package contains all implementations of {@link org.bukkit.event.Listener} that Slimefun uses.
+ */
+package io.github.thebusybiscuit.slimefun4.implementation.listeners;

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/setup/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * In this package we initialize our items, researches and stuff.
+ */
+package io.github.thebusybiscuit.slimefun4.implementation.setup;

src/main/java/io/github/thebusybiscuit/slimefun4/implementation/tasks/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * This package contains several tasks that Slimefun runs regularly.
+ */
+package io.github.thebusybiscuit.slimefun4.implementation.tasks;

src/main/java/io/github/thebusybiscuit/slimefun4/utils/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * This package contains some utility classes that offer handy ways to do stuff.
+ * They are often not directly related to Slimefun.
+ */
+package io.github.thebusybiscuit.slimefun4.utils;