(commons-text) branch master updated: Javadoc

[gg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-text.git


The following commit(s) were added to refs/heads/master by this push:
     new ddea4e0b Javadoc
ddea4e0b is described below

commit ddea4e0bfcf2eccf78b2e6bf8192d31138f065d7
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed Mar 20 09:31:38 2024 -0400

    Javadoc
---
 .../java/org/apache/commons/text/lookup/FileStringLookup.java    | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java b/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
index e430ea20..51297faa 100644
--- a/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
@@ -24,15 +24,18 @@ import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.text.StringSubstitutor;
 
 /**
- * Looks up keys from a file.
+ * Looks up file contents.
  * <p>
  * Using a {@link StringLookup} from the {@link StringLookupFactory}:
  * </p>
  *
  * <pre>
- * StringLookupFactory.INSTANCE.fileStringLookup().lookup(UTF-8:com/domain/document.properties");
+ * StringLookupFactory.INSTANCE.fileStringLookup().lookup("UTF-8:com/domain/document.properties");
  * </pre>
  * <p>
+ * The above example converts {@code "UTF-8:com/domain/document.properties"} to the UTF-8 contents of the file at {@code com/domain/document.properties}.
+ * </p>
+ * <p>
  * Using a {@link StringSubstitutor}:
  * </p>
  *
@@ -40,7 +43,7 @@ import org.apache.commons.text.StringSubstitutor;
  * StringSubstitutor.createInterpolator().replace("... ${file:UTF-8:com/domain/document.properties} ..."));
  * </pre>
  * <p>
- * The above examples convert {@code "UTF-8:SomePath"} to the contents of the file.
+ * The above example converts {@code "UTF-8:SomePath"} to the UTF-8 contents of the file at {@code SomePath}.
  * </p>
  *
  * @since 1.5