fix javadoc

This commit is contained in:
SirYwell 2022-07-03 12:02:15 +02:00
parent dce4922d34
commit f9f1a21cab

View File

@ -190,9 +190,8 @@ public final class CaptionLoader {
/**
* Load a message file into a new CaptionMap. The file name must match
* the pattern {@code messages_<locale>.json} where {@code <locale>}
* is a valid {@link Locale} string. Note that this method does not attempt to
* create a new file.
* the pattern expected by the {@link #localeExtractor}.
* Note that this method does not attempt to create a new file.
*
* @param file The file to load
* @return A new CaptionMap containing the loaded messages
@ -213,15 +212,16 @@ public final class CaptionLoader {
/**
* Load a message file into a new CaptionMap. The file name must match
* the pattern {@code messages_<locale>.json} where {@code <locale>}
* is a valid {@link Locale} string. If no file exists at the given path, this method will
* the pattern expected by the {@link #localeExtractor}.
* If no file exists at the given path, this method will
* attempt to create one and fill it with default values.
*
* @param file The file to load
* @return A new CaptionMap containing the loaded messages
* @throws IOException if the file couldn't be accessed or read successfully.
* @throws IllegalArgumentException if the file name doesn't match the specified format.
* @see #loadOrCreateSingle(Path)
* @see #loadSingle(Path)
* @since TODO
*/
public @NonNull CaptionMap loadOrCreateSingle(final @NonNull Path file) throws IOException {
final Locale locale = this.localeExtractor.apply(file);