From 944fc1cd463dc718eae21089afffa7344d985773 Mon Sep 17 00:00:00 2001 From: Jordan Irwin Date: Wed, 19 Jan 2022 17:30:46 -0800 Subject: [PATCH] Update some javadoc deprecation notices --- src/games/stendhal/client/entity/Entity.java | 2 +- src/games/stendhal/client/entity/RPEntity.java | 2 ++ src/games/stendhal/server/core/engine/StendhalRPWorld.java | 2 +- .../stendhal/server/core/scripting/lua/LuaEntityHelper.java | 4 ++++ src/games/stendhal/server/entity/GuidedEntity.java | 2 ++ src/games/stendhal/server/entity/Outfit.java | 2 ++ 6 files changed, 12 insertions(+), 2 deletions(-) diff --git a/src/games/stendhal/client/entity/Entity.java b/src/games/stendhal/client/entity/Entity.java index 09396b995e..9c54fc8a07 100644 --- a/src/games/stendhal/client/entity/Entity.java +++ b/src/games/stendhal/client/entity/Entity.java @@ -732,7 +732,7 @@ public class Entity implements RPObjectChangeListener, IEntity { * * @param object * The object. - * @deprecated Moving to different listener. Use release(). + * @deprecated Moving to different listener. Use {@link #release()}. */ @Override @Deprecated diff --git a/src/games/stendhal/client/entity/RPEntity.java b/src/games/stendhal/client/entity/RPEntity.java index 9ac4527911..db919fd5b3 100644 --- a/src/games/stendhal/client/entity/RPEntity.java +++ b/src/games/stendhal/client/entity/RPEntity.java @@ -419,6 +419,8 @@ public abstract class RPEntity extends AudibleEntity { * Get the outfit code. * * @return The outfit code. + * @deprecated + * Use {@link #getExtOutfit()}. */ @Deprecated public int getOutfit() { diff --git a/src/games/stendhal/server/core/engine/StendhalRPWorld.java b/src/games/stendhal/server/core/engine/StendhalRPWorld.java index 812648ea66..ff7ef8397c 100644 --- a/src/games/stendhal/server/core/engine/StendhalRPWorld.java +++ b/src/games/stendhal/server/core/engine/StendhalRPWorld.java @@ -110,7 +110,7 @@ public class StendhalRPWorld extends RPWorld { * Groovy bug has been resolved. * * @return StendhalRPWorld - * @deprecated use StendhalRPWorld.get() + * @deprecated use {@link #get()}. */ @Deprecated public static StendhalRPWorld getInstance() { diff --git a/src/games/stendhal/server/core/scripting/lua/LuaEntityHelper.java b/src/games/stendhal/server/core/scripting/lua/LuaEntityHelper.java index 6e4846bfd4..19a6754a7d 100644 --- a/src/games/stendhal/server/core/scripting/lua/LuaEntityHelper.java +++ b/src/games/stendhal/server/core/scripting/lua/LuaEntityHelper.java @@ -217,6 +217,8 @@ public class LuaEntityHelper { * The NPC instance of which path is being set. * @param table * Lua table with list of coordinates representing nodes. + * @deprecated + * Use {@link games.stendhal.server.entity.GuidedEntity#setPath(FixedPath). */ @Deprecated public void setPath(final RPEntity entity, final LuaTable table, Boolean loop) { @@ -236,6 +238,8 @@ public class LuaEntityHelper { * The NPC instance of which path is being set. * @param table * Lua table with list of coordinates representing nodes. + * @deprecated + * Use {@link games.stendhal.server.entity.GuidedEntity#setPathAndPosition(FixedPath)}. */ @Deprecated public void setPathAndPosition(final RPEntity entity, final LuaTable table, Boolean loop) { diff --git a/src/games/stendhal/server/entity/GuidedEntity.java b/src/games/stendhal/server/entity/GuidedEntity.java index 6b654780e1..64162e3044 100644 --- a/src/games/stendhal/server/entity/GuidedEntity.java +++ b/src/games/stendhal/server/entity/GuidedEntity.java @@ -180,6 +180,8 @@ public abstract class GuidedEntity extends ActiveEntity { /** * backward compatibility + * + * @deprecated Use {@link #setRetracePath()}. */ @Deprecated public void retracePath() { diff --git a/src/games/stendhal/server/entity/Outfit.java b/src/games/stendhal/server/entity/Outfit.java index 5f9ec66bb7..a40b38e3b0 100644 --- a/src/games/stendhal/server/entity/Outfit.java +++ b/src/games/stendhal/server/entity/Outfit.java @@ -295,6 +295,8 @@ public class Outfit { * The index of the dress style, or null * @param body * The index of the body style, or null + * @deprecated + * Use {@link #Outfit(String)} or {@link #Outfit(Integer...)}. */ @Deprecated public Outfit(final Integer detail, Integer hair, Integer head,