From c32b2a4b511c4ddb587c8e51fff4ad6d61ec1f58 Mon Sep 17 00:00:00 2001 From: Jeremy Wood Date: Tue, 28 Mar 2023 17:36:02 -0400 Subject: [PATCH] Update Javadoc for MVConfig. --- .../com/onarandombox/MultiverseCore/api/MVConfig.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/main/java/com/onarandombox/MultiverseCore/api/MVConfig.java b/src/main/java/com/onarandombox/MultiverseCore/api/MVConfig.java index 95a0baf5..55d11a78 100644 --- a/src/main/java/com/onarandombox/MultiverseCore/api/MVConfig.java +++ b/src/main/java/com/onarandombox/MultiverseCore/api/MVConfig.java @@ -35,8 +35,9 @@ public interface MVConfig { /** * Gets a property from the config. * - * @param name The name of the property. - * @return The value of the property. + * @param name The name of the property. + * @return A {@link Try} with the value of the property, otherwise a {@link Try.Failure} if there is no property by + * that name. */ Try getProperty(String name); @@ -45,7 +46,8 @@ public interface MVConfig { * * @param name The name of the property. * @param value The value of the property. - * @return True if the property was set successfully. + * @return An empty {@link Try} if the property was set successfully, otherwise a {@link Try.Failure} with the + * exception explaining why the property could not be set. */ Try setProperty(String name, Object value);