From 8d33d0408fef85ffff2ef07db172d67db99e5263 Mon Sep 17 00:00:00 2001 From: Lizbeth Rika Date: Tue, 2 Sep 2014 22:48:25 +0100 Subject: [PATCH] API documentation... --- MODSRC/vazkii/botania/api/package-info.java | 2 +- MODSRC/vazkii/botania/api/wiki/IWikiProvider.java | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/MODSRC/vazkii/botania/api/package-info.java b/MODSRC/vazkii/botania/api/package-info.java index 1eddc31b6..5499a2b4f 100644 --- a/MODSRC/vazkii/botania/api/package-info.java +++ b/MODSRC/vazkii/botania/api/package-info.java @@ -1,4 +1,4 @@ -@API(owner = "Botania", apiVersion = "10", provides = "BotaniaAPI") +@API(owner = "Botania", apiVersion = "11", provides = "BotaniaAPI") package vazkii.botania.api; import cpw.mods.fml.common.API; diff --git a/MODSRC/vazkii/botania/api/wiki/IWikiProvider.java b/MODSRC/vazkii/botania/api/wiki/IWikiProvider.java index 7172cc554..68d599734 100644 --- a/MODSRC/vazkii/botania/api/wiki/IWikiProvider.java +++ b/MODSRC/vazkii/botania/api/wiki/IWikiProvider.java @@ -14,12 +14,26 @@ package vazkii.botania.api.wiki; import net.minecraft.util.MovingObjectPosition; import net.minecraft.world.World; +/** + * An interface for a Wiki Provider, these are registered to allow a mod to provide a wiki + * for all the blocks in them, used for the world interaction with the Lexica Botania. + * A simple, mostly all-inclusive implementation can be found on SimpleWikiProvider. + */ public interface IWikiProvider { + /** + * Gets the name of the block being looked at for display. + */ public String getBlockName(World world, MovingObjectPosition pos); + /** + * Gets the URL to open when the block is clicked. + */ public String getWikiURL(World world, MovingObjectPosition pos); + /** + * Gets the name of the wiki for display. + */ public String getWikiName(World world, MovingObjectPosition pos); }