docs: javadoc

SkriptLang · Oct 2, 2024 · d49018b · d49018b
1 parent fd28c5c
commit d49018b
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/main/java/ch/njol/skript/bukkitutil/BukkitUnsafe.java b/src/main/java/ch/njol/skript/bukkitutil/BukkitUnsafe.java
@@ -65,12 +65,26 @@ public class BukkitUnsafe {
 	@Nullable
 	private static Map<Integer,Material> idMappings;
 
+	/**
+	 * @deprecated You should use {@link BukkitUnsafe#getMaterialFromNamespacedId(String)}
+	 * Get a material from a minecraft id.
+	 *
+	 * @param id Namespaced id (just like 'minecraft:dirt'), or normally just a material name (just like 'dirt')
+	 * @return Material or null
+	 */
 	@Nullable
 	@Deprecated
 	public static Material getMaterialFromMinecraftId(String id) {
 		return getMaterialFromNamespacedId(id);
 	}
 
+	/**
+	 * Get a material from a namespaced id.
+	 * Such as, minecraft:iron_ingot -> IRON_INGOT; mod:an_item -> mod_an_item
+	 *
+	 * @param id Namespaced id (just like 'minecraft:dirt'), or normally just a material name (just like 'dirt')
+	 * @return Material or null
+	 */
 	@Nullable
 	public static Material getMaterialFromNamespacedId(String id) {
 		return Material.matchMaterial(id.toLowerCase().startsWith(NamespacedKey.MINECRAFT + ":")