refactor: use @example annotations instead of @examples

Author: bluelhf

src/main/java/ch/njol/skript/conditions/CondAllayCanDuplicate.java

@@ -2,18 +2,18 @@
 
 import ch.njol.skript.conditions.base.PropertyCondition;
 import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
 import ch.njol.skript.doc.Since;
 import org.bukkit.entity.Allay;
 import org.bukkit.entity.LivingEntity;
 
 @Name("Allay Can Duplicate")
 @Description("Checks to see if an allay is able to duplicate naturally.")
-@Examples({
-	"if last spawned allay can duplicate:",
-		"\tdisallow last spawned to duplicate"
-})
+@Example("""
+	if last spawned allay can duplicate:
+		disallow last spawned to duplicate
+	""")
 @Since("2.11")
 public class CondAllayCanDuplicate extends PropertyCondition<LivingEntity> {
 

src/main/java/ch/njol/skript/conditions/CondAlphanumeric.java

@@ -16,8 +16,10 @@
 
 @Name("Alphanumeric")
 @Description({"Checks if the given string is alphanumeric."})
-@Examples({"if the argument is not alphanumeric:",
-		"	send \"Invalid name!\""})
+@Examples("""
+	if the argument is not alphanumeric:
+		send "Invalid name!"
+	""")
 @Since("2.4")
 public class CondAlphanumeric extends Condition {
 

src/main/java/ch/njol/skript/conditions/CondIsCharged.java

@@ -2,7 +2,7 @@
 
 import ch.njol.skript.conditions.base.PropertyCondition;
 import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
 import ch.njol.skript.doc.Since;
 import org.bukkit.entity.Creeper;
@@ -12,10 +12,10 @@
 
 @Name("Is Charged")
 @Description("Checks if a creeper, wither, or wither skull is charged (powered).")
-@Examples({
-	"if the last spawned creeper is charged:",
-		"\tbroadcast \"A charged creeper is at %location of last spawned creeper%\""
-})
+@Example("""
+	if the last spawned creeper is charged:
+		broadcast "A charged creeper is at %location of last spawned creeper%"
+	""")
 @Since("2.5, 2.10 (withers, wither skulls)")
 public class CondIsCharged extends PropertyCondition<Entity> {
 

src/main/java/ch/njol/skript/conditions/CondIsSwimming.java

@@ -2,11 +2,12 @@
 
 import ch.njol.skript.conditions.base.PropertyCondition;
 import ch.njol.skript.doc.*;
+import ch.njol.skript.doc.Example;
 import org.bukkit.entity.LivingEntity;
 
 @Name("Is Swimming")
 @Description("Checks whether a living entity is swimming.")
-@Examples("player is swimming")
+@Example("player is swimming")
 @Since("2.3")
 public class CondIsSwimming extends PropertyCondition<LivingEntity> {
 

src/main/java/ch/njol/skript/conditions/CondScriptLoaded.java

@@ -4,7 +4,7 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.SkriptCommand;
 import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Condition;
@@ -20,10 +20,8 @@
 
 @Name("Is Script Loaded")
 @Description("Check if the current script, or another script, is currently loaded.")
-@Examples({
-	"script is loaded",
-	"script \"example.sk\" is loaded"
-})
+@Example("script is loaded")
+@Example("script \"example.sk\" is loaded")
 @Since("2.2-dev31")
 public class CondScriptLoaded extends Condition {
 

src/main/java/ch/njol/skript/effects/EffApplyBoneMeal.java

@@ -2,7 +2,7 @@
 
 import ch.njol.skript.Skript;
 import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
 import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
@@ -18,7 +18,7 @@
 
 @Name("Apply Bone Meal")
 @Description("Applies bone meal to a crop, sapling, or composter")
-@Examples("apply 3 bone meal to event-block")
+@Example("apply 3 bone meal to event-block")
 @RequiredPlugins("MC 1.16.2+")
 @Since("2.8.0")
 public class EffApplyBoneMeal extends Effect {

src/main/java/ch/njol/skript/effects/EffBreakNaturally.java

@@ -8,7 +8,7 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.aliases.ItemType;
 import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Effect;
@@ -20,9 +20,18 @@
 @Description({"Breaks the block and spawns items as if a player had mined it",
 		"\nYou can add a tool, which will spawn items based on how that tool would break the block ",
 		"(ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)"})
-@Examples({"on right click:", "\tbreak clicked block naturally",
-		"loop blocks in radius 10 around player:", "\tbreak loop-block using player's tool",
-		"loop blocks in radius 10 around player:", "\tbreak loop-block naturally using diamond pickaxe"})
+@Example("""
+	on right click:
+		break clicked block naturally
+	""")
+@Example("""
+	loop blocks in radius 10 around player:
+		break loop-block using player's tool
+	""")
+@Example("""
+	loop blocks in radius 10 around player:
+		break loop-block naturally using diamond pickaxe
+	""")
 @Since("2.4")
 public class EffBreakNaturally extends Effect {
 

src/main/java/ch/njol/skript/effects/EffCharge.java

@@ -2,7 +2,7 @@
 
 import ch.njol.skript.Skript;
 import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Effect;
@@ -17,10 +17,10 @@
 
 @Name("Charge Entity")
 @Description("Charges or uncharges a creeper or wither skull. A creeper is charged when it has been struck by lightning.")
-@Examples({
-	"on spawn of creeper:",
-		"\tcharge the event-entity"
-})
+@Example("""
+	on spawn of creeper:
+		charge the event-entity
+	""")
 @Since("2.5, 2.10 (wither skulls)")
 public class EffCharge extends Effect {
 

src/main/java/ch/njol/skript/effects/EffColorItems.java

@@ -10,7 +10,7 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.aliases.ItemType;
 import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Effect;
@@ -27,8 +27,8 @@
 		"You can also use RGB codes if you feel limited with the 16 default colors. " +
 		"RGB codes are three numbers from 0 to 255 in the order <code>(red, green, blue)</code>, where <code>(0,0,0)</code> is black and <code>(255,255,255)</code> is white. " +
 		"Armor is colorable for all Minecraft versions. With Minecraft 1.11 or newer you can also color potions and maps. Note that the colors might not look exactly how you'd expect.")
-@Examples({"dye player's helmet blue",
-		"color the player's tool red"})
+@Example("dye player's helmet blue")
+@Example("color the player's tool red")
 @Since("2.0, 2.2-dev26 (maps and potions)")
 public class EffColorItems extends Effect {
 

src/main/java/ch/njol/skript/effects/EffForceAttack.java

@@ -7,7 +7,7 @@
 
 import ch.njol.skript.Skript;
 import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
 import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
@@ -18,8 +18,10 @@
 
 @Name("Force Attack")
 @Description("Makes a living entity attack an entity with a melee attack.")
-@Examples({"spawn a wolf at player's location",
-	"make last spawned wolf attack player"})
+@Example("""
+	spawn a wolf at player's location
+	make last spawned wolf attack player
+	""")
 @Since("2.5.1")
 @RequiredPlugins("Minecraft 1.15.2+")
 public class EffForceAttack extends Effect {
@@ -29,7 +31,7 @@ public class EffForceAttack extends Effect {
 			"make %livingentities% attack %entity%",
 			"force %livingentities% to attack %entity%");
 	}
-	
+
 	@SuppressWarnings("null")
 	private Expression<LivingEntity> entities;
 	@SuppressWarnings("null")
@@ -52,7 +54,7 @@ protected void execute(Event e) {
 			}
 		}
 	}
-	
+
 	@Override
 	public String toString(@Nullable Event e, boolean debug) {
 		return "make " + entities.toString(e, debug) + " attack " + target.toString(e, debug);