Merge branch 'consistent-documentation'

Author: ljacqu

CONTRIBUTING.md

@@ -20,6 +20,14 @@ of the AuthMe Discord server.
 
 No sweat if some points aren't met since they can be addressed in pull requests, and PRs can be squashed.
 
+### Glossary
+
+Try to use and write terms consistently. Some spellings:
+
+- ConfigMe
+- Javadoc (always capitalized)
+- _no-arg constructor_ (not "zero-arg(s)")
+
 ## Code style
 
 Please try to match the current code style. A few pointers:

README.md

@@ -1,7 +1,7 @@
 # ConfigMe
 [![Build Status](https://github.com/AuthMe/ConfigMe/actions/workflows/maven_jdk8.yml/badge.svg)](https://github.com/AuthMe/ConfigMe/actions?query=branch%3Amaster)
 [![Coverage Status](https://coveralls.io/repos/github/AuthMe/ConfigMe/badge.svg?branch=master)](https://coveralls.io/github/AuthMe/ConfigMe?branch=master)
-[![Javadocs](https://www.javadoc.io/badge/ch.jalu/configme.svg)](https://www.javadoc.io/doc/ch.jalu/configme)
+[![Javadoc](https://www.javadoc.io/badge/ch.jalu/configme.svg)](https://www.javadoc.io/doc/ch.jalu/configme)
 [![MegaLinter](https://github.com/AuthMe/ConfigMe/workflows/MegaLinter/badge.svg?branch=master)](https://github.com/AuthMe/ConfigMe/actions?query=workflow%3AMegaLinter+branch%3Amaster)
 
 A simple configuration management library with YAML support out of the box.

src/main/java/ch/jalu/configme/SettingsHolder.java

@@ -10,7 +10,7 @@
  * of {@link ch.jalu.configme.properties.Property} type in a class
  * which implements this interface.
  * <p>
- * Classes implementing this interface must have a no-args constructor (any visibility).
+ * Classes implementing this interface must have a no-arg constructor (any visibility).
  *
  * @see ch.jalu.configme.properties.PropertyInitializer
  * @see ch.jalu.configme.configurationdata.ConfigurationDataBuilder

src/main/java/ch/jalu/configme/beanmapper/Mapper.java

@@ -6,7 +6,7 @@
 import org.jetbrains.annotations.Nullable;
 
 /**
- * Maps the values of a property reader to Java classes (referred to as beans). See the JavaDoc on the default
+ * Maps the values of a property reader to Java classes (referred to as beans). See the Javadoc on the default
  * implementation, {@link MapperImpl}, for more details.
  */
 public interface Mapper {

src/main/java/ch/jalu/configme/configurationdata/ConfigurationDataBuilder.java

@@ -181,7 +181,7 @@ protected void collectSectionComments(@NotNull Class<? extends SettingsHolder> c
             ReflectionHelper.setAccessibleIfNeeded(constructor);
             return constructor.newInstance();
         } catch (NoSuchMethodException e) {
-            throw new ConfigMeException("Expected no-args constructor to be available for " + clazz, e);
+            throw new ConfigMeException("Expected no-arg constructor to be available for " + clazz, e);
         } catch (IllegalAccessException | InstantiationException | InvocationTargetException e) {
             throw new ConfigMeException("Could not create instance of " + clazz, e);
         }

src/main/java/ch/jalu/configme/configurationdata/PropertyListBuilder.java

@@ -46,7 +46,7 @@ public void add(@NotNull Property<?> property) {
 
     /**
      * Creates a list of properties that have been added, by insertion order but grouped by path parents
-     * (see class JavaDoc).
+     * (see class Javadoc).
      *
      * @return ordered list of registered properties
      */

src/main/java/ch/jalu/configme/properties/convertresult/ConvertErrorRecorder.java

@@ -19,7 +19,7 @@ public class ConvertErrorRecorder {
     private boolean hasError;
 
     /**
-     * Registers that some error occurred during the conversion of the value. See class javadoc: no need to register
+     * Registers that some error occurred during the conversion of the value. See class Javadoc: no need to register
      * an error if the return value of the conversion implies there is an issue (such as returning null).
      *
      * @param reason the reason (not used in this implementation but may be extended for debugging)

src/main/java/ch/jalu/configme/utils/SettingsHolderClassValidator.java

@@ -141,7 +141,7 @@ public void validateSettingsHolderClassesFinal(@NotNull Iterable<Class<? extends
 
     /**
      * Throws an exception if any of the provided setting holder classes does not have a single private
-     * no-args constructor.
+     * no-arg constructor.
      *
      * @param settingHolders the classes to check
      */
@@ -156,7 +156,7 @@ public void validateClassesHaveHiddenNoArgConstructor(
         }
 
         if (!invalidClasses.isEmpty()) {
-            throw new IllegalStateException("The following classes do not have a single no-args private constructor:"
+            throw new IllegalStateException("The following classes do not have a single no-arg private constructor:"
                 + "\n- " + String.join("\n- ", invalidClasses));
         }
     }

src/test/java/ch/jalu/configme/configurationdata/ConfigurationDataBuilderTest.java

@@ -61,10 +61,10 @@ void shouldGetAllProperties() {
     void shouldHandleSettingsHolderConstructorIssues() {
         ConfigMeException ex;
 
-        // Missing no-args constructor
+        // Missing no-arg constructor
         ex = assertThrows(ConfigMeException.class,
-            () -> ConfigurationDataBuilder.createConfiguration(IllegalSettingsHolderConstructorClasses.MissingNoArgsConstructor.class));
-        assertThat(ex.getMessage(), startsWith("Expected no-args constructor to be available for class "));
+            () -> ConfigurationDataBuilder.createConfiguration(IllegalSettingsHolderConstructorClasses.MissingNoArgConstructor.class));
+        assertThat(ex.getMessage(), startsWith("Expected no-arg constructor to be available for class "));
 
         // Constructor throws exception
         ex = assertThrows(ConfigMeException.class,
@@ -79,7 +79,7 @@ void shouldHandleSettingsHolderConstructorIssues() {
         // Class is interface
         ex = assertThrows(ConfigMeException.class,
             () -> ConfigurationDataBuilder.createConfiguration(IllegalSettingsHolderConstructorClasses.InterfaceSettingsHolder.class));
-        assertThat(ex.getMessage(), startsWith("Expected no-args constructor to be available for interface "));
+        assertThat(ex.getMessage(), startsWith("Expected no-arg constructor to be available for interface "));
     }
 
     @Test

src/test/java/ch/jalu/configme/configurationdata/samples/IllegalSettingsHolderConstructorClasses.java

@@ -12,11 +12,11 @@ private IllegalSettingsHolderConstructorClasses() {
     }
 
     /**
-     * Class doesn't have a no-args constructor.
+     * Class doesn't have a no-arg constructor.
      */
-    public final static class MissingNoArgsConstructor implements SettingsHolder {
+    public final static class MissingNoArgConstructor implements SettingsHolder {
 
-        MissingNoArgsConstructor(String str) {
+        MissingNoArgConstructor(String str) {
         }
     }