refactor(docs): continue work on Examples->Example migration

Author: bluelhf

src/main/java/ch/njol/skript/expressions/ExprActiveItem.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,11 +18,11 @@
 	"the bow they're drawing back, etc.). This cannot be changed. " +
 	"If an entity is not using any item, this will return null."
 )
-@Examples({
-	"on damage of player:",
-		"\tif victim's active tool is a bow:",
-			"\t\tinterrupt player's active item use"
-})
+@Example("""
+	on damage of player:
+		if victim's active tool is a bow:
+			interrupt player's active item use
+	""")
 @Since("2.8.0")
 @RequiredPlugins("Paper")
 public class ExprActiveItem extends SimplePropertyExpression<LivingEntity, ItemStack> {

src/main/java/ch/njol/skript/expressions/ExprAttacker.java

@@ -15,7 +15,7 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Events;
-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.Expression;
@@ -32,10 +32,12 @@
 @Name("Attacker")
 @Description({"The attacker of a damage event, e.g. when a player attacks a zombie this expression represents the player.",
 		"Please note that the attacker can also be a block, e.g. a cactus or lava, but this expression will not be set in these cases."})
-@Examples({"on damage:",
-		"	attacker is a player",
-		"	health of attacker is less than or equal to 2",
-		"	damage victim by 1 heart"})
+@Example("""
+	on damage:
+		attacker is a player
+		health of attacker is less than or equal to 2
+		damage victim by 1 heart
+	""")
 @Since("1.3")
 @Events({"damage", "death", "destroy"})
 public class ExprAttacker extends SimpleExpression<Entity> implements EventRestrictedSyntax {

src/main/java/ch/njol/skript/expressions/ExprBlock.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.expressions.base.EventValueExpression;
@@ -25,14 +25,18 @@
 @Name("Block")
 @Description({"The block involved in the event, e.g. the clicked block or the placed block.",
 		"Can optionally include a direction as well, e.g. 'block above' or 'block in front of the player'."})
-@Examples({"block is iron ore",
-		"set block below to air",
-		"spawn a creeper above the block",
-		"loop blocks in radius 4:",
-		"	loop-block is obsidian",
-		"	set loop-block to water",
-		"block is a chest:",
-		"	clear the inventory of the block"})
+@Example("block is iron ore")
+@Example("set block below to air")
+@Example("spawn a creeper above the block")
+@Example("""
+loop blocks in radius 4:
+	loop-block is obsidian
+	set loop-block to water
+""")
+@Example("""
+block is a chest:
+	clear the inventory of the block
+""")
 @Since("1.0")
 public class ExprBlock extends WrapperExpression<Block> {
 	static {

src/main/java/ch/njol/skript/expressions/ExprEnchantmentBonus.java

@@ -7,7 +7,7 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Events;
-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.Expression;
@@ -19,8 +19,10 @@
 
 @Name("Enchantment Bonus")
 @Description("The enchantment bonus in an enchant prepare event. This represents the number of bookshelves affecting/surrounding the enchantment table.")
-@Examples({"on enchant:", 
-			"\tsend \"There are %enchantment bonus% bookshelves surrounding this enchantment table!\" to player"})
+@Example("""
+	on enchant:
+		send "There are %enchantment bonus% bookshelves surrounding this enchantment table!" to player
+	""")
 @Events("enchant prepare")
 @Since("2.5")
 public class ExprEnchantmentBonus extends SimpleExpression<Long> {

src/main/java/ch/njol/skript/expressions/ExprEntityAttribute.java

@@ -3,7 +3,7 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.classes.Changer.ChangeMode;
 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.expressions.base.PropertyExpression;
@@ -28,11 +28,11 @@
 	"Note that the movement speed attribute cannot be reliably used for players. For that purpose, use the speed expression instead.",
 	"Resetting an entity's attribute is only available in Minecraft 1.11 and above."
 })
-@Examples({
-	"on damage of player:",
-		"\tsend \"You are wounded!\" to victim",
-		"\tset victim's attack speed attribute to 2"
-})
+@Example("""
+	on damage of player:
+		send "You are wounded!" to victim
+		set victim's attack speed attribute to 2
+	""")
 @Since("2.5, 2.6.1 (final attribute value)")
 public class ExprEntityAttribute extends PropertyExpression<Entity, Number> {
 

src/main/java/ch/njol/skript/expressions/ExprEvtInitiator.java

@@ -3,7 +3,7 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Events;
-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.Expression;
@@ -19,11 +19,11 @@
 
 @Name("Initiator Inventory")
 @Description("Returns the initiator inventory in an on <a href=\"?search=#inventory_item_move\">inventory item move</a> event.")
-@Examples({
-	"on inventory item move:",
-		"\tholder of event-initiator-inventory is a chest",
-		"\tbroadcast \"Item transport happening at %location at holder of event-initiator-inventory%!\""
-})
+@Example("""
+	on inventory item move:
+		holder of event-initiator-inventory is a chest
+		broadcast "Item transport happening at %location at holder of event-initiator-inventory%!"
+	""")
 @Events("Inventory Item Move")
 @Since("2.8.0")
 public class ExprEvtInitiator extends SimpleExpression<Inventory> {

src/main/java/ch/njol/skript/expressions/ExprExperienceCooldown.java

@@ -2,7 +2,7 @@
 
 import ch.njol.skript.classes.Changer.ChangeMode;
 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.expressions.base.SimplePropertyExpression;
@@ -19,12 +19,12 @@
 	"Experience cooldown is how long until a player can pick up another orb of experience.",
 	"The cooldown of a player must be 0 to pick up another orb of experience."
 })
-@Examples({
-	"send experience cooldown of player",
-	"set the xp pickup cooldown of player to 1 hour",
-	"if exp collection cooldown of player >= 10 minutes:",
-		"\tclear the experience pickup cooldown of player"
-})
+@Example("send experience cooldown of player")
+@Example("set the xp pickup cooldown of player to 1 hour")
+@Example("""
+	if exp collection cooldown of player >= 10 minutes:
+		clear the experience pickup cooldown of player
+	""")
 @Since("2.10")
 public class ExprExperienceCooldown extends SimplePropertyExpression<Player, Timespan> {
 

src/main/java/ch/njol/skript/expressions/ExprExperienceCooldownChangeReason.java

@@ -1,7 +1,7 @@
 package ch.njol.skript.expressions;
 
 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.expressions.base.EventValueExpression;
@@ -14,13 +14,13 @@
 	"The <a href='#experiencechangereason'>experience change reason</a> within an " +
 	"<a href='#experience%20cooldown%20change%20event'>experience cooldown change event</a>."
 })
-@Examples({
-	"on player experience cooldown change:",
-		"\tif xp cooldown change reason is plugin:",
-			"\t\t#Changed by a plugin",
-		"\telse if xp cooldown change reason is orb pickup:",
-			"\t\t#Changed by picking up xp orb"
-})
+@Example("""
+	on player experience cooldown change:
+		if xp cooldown change reason is plugin:
+			#Changed by a plugin
+		else if xp cooldown change reason is orb pickup:
+			#Changed by picking up xp orb
+	""")
 @Since("2.10")
 public class ExprExperienceCooldownChangeReason extends EventValueExpression<ChangeReason> {
 

src/main/java/ch/njol/skript/expressions/ExprExplosionBlockYield.java

@@ -8,7 +8,7 @@
 import ch.njol.skript.classes.Changer.ChangeMode;
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Events;
-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.Expression;
@@ -23,8 +23,10 @@
 @Description({"The percentage of exploded blocks dropped in an explosion event.",
 				"When changing the yield, a value greater than 1 will function the same as using 1.",
 				"Attempting to change the yield to a value less than 0 will have no effect."})
-@Examples({"on explode:",
-			"set the explosion's block yield to 10%"})
+@Example("""
+	on explode:
+		set the explosion's block yield to 10%
+	""")
 @Events("explosion")
 @Since("2.5")
 public class ExprExplosionBlockYield extends SimpleExpression<Number> {

src/main/java/ch/njol/skript/expressions/ExprFallDistance.java

@@ -6,17 +6,19 @@
 
 import ch.njol.skript.classes.Changer.ChangeMode;
 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.expressions.base.SimplePropertyExpression;
 import ch.njol.util.coll.CollectionUtils;
 
 @Name("Fall Distance")
 @Description({"The distance an entity has fallen for."})
-@Examples({"set all entities' fall distance to 10",
-	"on damage:",
-	"\tsend \"%victim's fall distance%\" to victim"})
+@Example("""
+	set all entities' fall distance to 10
+	on damage:
+		send "%victim's fall distance%" to victim
+	""")
 @Since("2.5")
 public class ExprFallDistance extends SimplePropertyExpression<Entity, Number> {