refactor(docs): finish migrating syntaxes from Examples annotations to Example

this changes the rest of the vanilla Skript syntaxes. the old Examples annotation is left there because addons probably use it still

Author: bluelhf

skript-aliases

@@ -4,13 +4,13 @@
 
 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;
 
 @Name("Has AI")
 @Description("Checks whether an entity has AI.")
-@Examples("target entity has ai")
+@Example("target entity has ai")
 @Since("2.5")
 public class CondAI extends PropertyCondition<LivingEntity> {
 

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

@@ -3,7 +3,7 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.doc.Name;
 import ch.njol.skript.doc.Description;
-import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Condition;
@@ -16,7 +16,7 @@
 
 @Name("Do Respawn Anchors Work")
 @Description("Checks whether or not respawn anchors work in a world.")
-@Examples("respawn anchors work in world \"world_nether\"")
+@Example("respawn anchors work in world \"world_nether\"")
 @RequiredPlugins("Minecraft 1.16+")
 @Since("2.7")
 public class CondAnchorWorks extends Condition {

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

@@ -4,13 +4,13 @@
 
 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;
 
 @Name("Can Fly")
 @Description("Whether a player is allowed to fly.")
-@Examples("player can fly")
+@Example("player can fly")
 @Since("2.3")
 public class CondCanFly extends PropertyCondition<Player> {
 

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

@@ -10,7 +10,7 @@
 import ch.njol.skript.conditions.base.PropertyCondition;
 import ch.njol.skript.conditions.base.PropertyCondition.PropertyType;
 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;
@@ -25,8 +25,8 @@
  */
 @Name("Can Hold")
 @Description("Tests whether a player or a chest can hold the given item.")
-@Examples({"block can hold 200 cobblestone",
-		"player has enough space for 64 feathers"})
+@Example("block can hold 200 cobblestone")
+@Example("player has enough space for 64 feathers")
 @Since("1.0")
 public class CondCanHold extends Condition {
 

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

@@ -2,21 +2,22 @@
 
 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.LivingEntity;
 
 @Name("Can Pick Up Items")
 @Description("Whether living entities are able to pick up items off the ground or not.")
-@Examples({
-	"if player can pick items up:",
-		"\tsend \"You can pick up items!\" to player",
-	"",
-	"on drop:",
-		"\tif player can't pick	up items:",
-			"\t\tsend \"Be careful, you won't be able to pick that up!\" to player"
-})
+@Example("""
+	if player can pick items up:
+		send "You can pick up items!" to player
+	""")
+@Example("""
+	on drop:
+		if player can't pick up items:
+			send "Be careful, you won't be able to pick that up!" to player
+	""")
 @Since("2.8.0")
 public class CondCanPickUpItems extends PropertyCondition<LivingEntity> {
 

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

@@ -15,13 +15,14 @@
 
 @Name("Can See")
 @Description("Checks whether the given players can see the provided entities.")
-@Examples({
-	"if sender can't see the player-argument:",
-		"\tmessage \"who dat?\"",
-	"",
-	"if the player can see the last spawned entity:",
-		"\tmessage \"hello there!\""
-})
+@Example("""
+	if sender can't see the player-argument:
+		message "who dat?"
+	""")
+@Example("""
+	if the player can see the last spawned entity:
+		message "hello there!"
+	""")
 @Since("2.3, 2.10 (entities)")
 @RequiredPlugins("Minecraft 1.19+ (entities)")
 public class CondCanSee extends Condition {

src/main/java/ch/njol/skript/conditions/CondCanSee.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.Condition;
@@ -15,10 +15,11 @@
 
 @Name("Event Cancelled")
 @Description("Checks whether or not the event is cancelled.")
-@Examples({"on click:",
-		"\tif event is cancelled:",
-		"\t\tbroadcast \"no clicks allowed!\""
-})
+@Example("""
+	on click:
+		if event is cancelled:
+			broadcast "no clicks allowed!"
+	""")
 @Since("2.2-dev36")
 public class CondCancelled extends Condition {
 

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

@@ -5,7 +5,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.Condition;
@@ -19,10 +19,12 @@
 @Name("Chance")
 @Description({"A condition that randomly succeeds or fails.",
 		"Valid values are between 0% and 100%, or if the percent sign is omitted between 0 and 1."})
-@Examples({"chance of 50%:",
-		"\tdrop a diamond",
-		"chance of {chance}% # {chance} between 0 and 100",
-		"chance of {chance} # {chance} between 0 and 1"})
+@Example("""
+	chance of 50%:
+		drop a diamond
+	""")
+@Example("chance of {chance}% # {chance} between 0 and 100")
+@Example("chance of {chance} # {chance} between 0 and 1")
 @Since("1.0")
 public class CondChance extends Condition {
 

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

@@ -8,12 +8,12 @@
 
 @Name("Can See Chat Colors")
 @Description("Checks whether a player can see chat colors.")
-@Examples({
-	"if player can see chat colors:",
-		"\tsend \"Find the red word in <red>this<reset> message.\"",
-	"else:",
-		"\tsend \"You cannot partake in finding the colored word.\""
-})
+@Example("""
+	if player can see chat colors:
+		send "Find the red word in <red>this<reset> message."
+	else:
+		send "You cannot partake in finding the colored word."
+	""")
 @RequiredPlugins("Paper")
 @Since("2.10")
 public class CondChatColors extends PropertyCondition<Player> {