Browse Source

Fixed javadocs

Dominik Fuchß 4 years ago
parent
commit
4dbc6277ef

+ 2 - 1
jplag.cli/src/main/java/de/jplag/CommandLineArgument.java

@@ -87,7 +87,8 @@ public enum CommandLineArgument {
             new Builder("--cluster-pp-threshold", Float.class).mutuallyExclusiveGroup(CLUSTERING_PREPROCESSING_GROUP_NAME).metaVar("threshold"));
 
     /**
-     * The short name of the default {@link Language}.
+     * The identifier of the default {@link Language}.
+     * @see Language#getIdentifier()
      */
     public static final String DEFAULT_LANGUAGE_IDENTIFIER = de.jplag.java.Language.IDENTIFIER;
 

+ 1 - 1
jplag.frontend-utils/src/main/java/de/jplag/Language.java

@@ -18,7 +18,7 @@ public interface Language {
     String getName();
 
     /**
-     * Short name of the language used for CLI options.
+     * Identifier of the language for CLI options and for dynamic loading of language.
      */
     String getIdentifier();
 

+ 2 - 2
jplag.frontend-utils/src/main/java/de/jplag/LanguageLoader.java

@@ -51,7 +51,7 @@ public final class LanguageLoader {
 
     /**
      * Load a language that is currently in the classpath by its short name.
-     * @param identifier the short name of the language
+     * @param identifier the identifier of the language
      * @return the language or an empty optional if no language has been found.
      * @see Language#getIdentifier()
      */
@@ -63,7 +63,7 @@ public final class LanguageLoader {
     }
 
     /**
-     * Get a list of all available languages with their short name.
+     * Get a list of all available languages with their identifiers.
      * @return the list of all languages
      */
     public static List<String> getAllAvailableLanguageIdentifiers() {