implement documents plus a bit more cleanup

Author: sovdeeth

src/main/java/ch/njol/skript/classes/ClassInfo.java

@@ -12,6 +12,7 @@
 import org.bukkit.event.Event;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.Unmodifiable;
 import org.skriptlang.skript.lang.properties.Property;
 import org.skriptlang.skript.lang.properties.Property.PropertyInfo;
 import org.skriptlang.skript.lang.properties.PropertyHandler;
@@ -477,22 +478,50 @@ public String toString(final @Nullable Event event, final boolean debug) {
 		return getName().getSingular();
 	}
 
-
 	private final Map<Property<?>, PropertyInfo<?>> propertyInfos = new HashMap<>();
+	private final Map<Property<?>, String> propertyDescriptions = new HashMap<>();
 
-	public <Handler extends PropertyHandler<T>> ClassInfo<T> property(Property<? super Handler> property, @NotNull Handler handler) {
+	/**
+	 * Registers this class as having the given property, using the given property handler.
+	 * @param property The property this class should have
+	 * @param description A short description of the property for documentation
+	 * @param handler The handler for this property
+	 * @return This ClassInfo object
+ 	 * @param <Handler> The type of the property handler
+	 * @throws IllegalStateException If this property is already registered for this class
+	 */
+	public <Handler extends PropertyHandler<T>> ClassInfo<T> property(Property<? super Handler> property, String description, @NotNull Handler handler) {
 		if (propertyInfos.containsKey(property)) {
 			throw new IllegalStateException("Property " + property.name() + " is already registered for the " + c.getName() + " type.");
 		}
 		propertyInfos.put(property, new PropertyInfo<>(property, handler));
 		Classes.CLASS_INFOS_BY_PROPERTY.computeIfAbsent(property, k -> new ArrayList<>()).add(this);
+		propertyDescriptions.put(property, description);
 		return this;
 	}
 
+	/**
+	 * Checks whether this class already has the given property registered.
+	 * @param property The property to check
+	 * @return True if this class has the property, false otherwise
+	 */
 	public boolean hasProperty(Property<?> property) {
 		return propertyInfos.containsKey(property);
 	}
 
+	/**
+	 * @return An unmodifiable collection of all the properties this class has.
+	 */
+	public @Unmodifiable Collection<Property<?>> getAllProperties() {
+		return Collections.unmodifiableCollection(propertyInfos.keySet());
+	}
+
+	/**
+	 * Gets the property info for the given property, or null if this class does not have the property.
+	 * @param property The property to get the info for
+	 * @return The property info, or null if this class does not have the property
+	 * @param <Handler> The type of the property handler
+	 */
 	public <Handler extends PropertyHandler<?>> @Nullable PropertyInfo<Handler> getPropertyInfo(Property<Handler> property) {
 		if (!propertyInfos.containsKey(property)) {
 			return null;
@@ -501,5 +530,14 @@ public boolean hasProperty(Property<?> property) {
 		return (PropertyInfo<Handler>) propertyInfos.get(property);
 	}
 
+	/**
+	 * Gets the description for the given property, or null if this class does not have the property.
+	 * Meant to be used for documentation.
+	 * @param property The property to get the description for
+	 * @return The description, or null if this class does not have the property
+	 */
+	public String getPropertyDescription(Property<?> property) {
+		return propertyDescriptions.get(property);
+	}
 
 }

src/main/java/ch/njol/skript/classes/data/BukkitClasses.java

@@ -413,7 +413,9 @@ public boolean mustSyncDeserialization() {
 						return true;
 					}
 				})
-				.property(Property.NAME, ExpressionPropertyHandler.of(World::getName, String.class))
+				.property(Property.NAME,
+					"A world's name, as text. Cannot be changed.",
+					ExpressionPropertyHandler.of(World::getName, String.class))
 		);
 
 		Classes.registerClass(new InventoryClassInfo());
@@ -485,7 +487,11 @@ public String toVariableNameString(final CommandSender s) {
 						return s.getName();
 					}
 				})
-				.property(Property.NAME, ExpressionPropertyHandler.of(CommandSender::getName, String.class)));
+				.property(Property.NAME,
+					"A command sender's name, as text. Cannot be changed.",
+					ExpressionPropertyHandler.of(CommandSender::getName, String.class)));
+
+		Classes.registerClass(new NameableClassInfo());
 
 		Classes.registerClass(new ClassInfo<>(InventoryHolder.class, "inventoryholder")
 				.name(ClassInfo.NO_DOC)
@@ -999,7 +1005,9 @@ public String[] getPatterns() {
 			.requiredPlugins("Minecraft 1.13 or newer")
 			.supplier(GameRule.values())
 			.parser(gameRuleParser)
-			.property(Property.NAME, ExpressionPropertyHandler.of(GameRule::getName, String.class))
+			.property(Property.NAME,
+				"A gamerule's name, as text. Cannot be changed.",
+				ExpressionPropertyHandler.of(GameRule::getName, String.class))
 		);
 
 		Classes.registerClass(new ClassInfo<>(EnchantmentOffer.class, "enchantmentoffer")

src/main/java/ch/njol/skript/classes/data/JavaClasses.java

@@ -304,7 +304,9 @@ public boolean mustSyncDeserialization() {
 						return false;
 					}
 				})
-				.property(Property.CONTAINS, new ContainsHandler<String, String>() {
+				.property(Property.CONTAINS,
+					"Strings can contain other strings.",
+					new ContainsHandler<String, String>() {
 					@Override
 					public boolean contains(String container, String element) {
 						return StringUtils.contains(container, element, SkriptConfig.caseSensitive.value());