Javadoc the new API

This commit is contained in:
Nicholas Ignoffo 2018-02-11 00:39:04 -08:00
parent aa5bf18552
commit 47482b6add
8 changed files with 152 additions and 14 deletions

View file

@ -1,6 +1,15 @@
package WayofTime.bloodmagic.api;
/**
* The main class to implement to create a Blood Magic plugin. Everything communicated between a mod and Blood Magic is through this class.
* IBloodMagicPlugins must have the {@link BloodMagicPlugin} annotation to get loaded by Blood Magic.
*/
public interface IBloodMagicPlugin {
/**
* Register mod content with the API
*
* @param api The active instance of the {@link IBloodMagicAPI}
*/
void register(IBloodMagicAPI api);
}