You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by ja...@apache.org on 2017/05/12 17:42:59 UTC

geode git commit: GEODE-2914: Tidy up LuceneService javadoc

Repository: geode
Updated Branches:
  refs/heads/feature/GEODE-2914 [created] 433e84e7a


GEODE-2914: Tidy up LuceneService javadoc


Project: http://git-wip-us.apache.org/repos/asf/geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/433e84e7
Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/433e84e7
Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/433e84e7

Branch: refs/heads/feature/GEODE-2914
Commit: 433e84e7a364228a1adbee1fdd7c0f7a7975ea8b
Parents: 0c5011e
Author: Jason Huynh <hu...@gmail.com>
Authored: Fri May 12 10:42:01 2017 -0700
Committer: Jason Huynh <hu...@gmail.com>
Committed: Fri May 12 10:42:01 2017 -0700

----------------------------------------------------------------------
 .../java/org/apache/geode/cache/lucene/LuceneService.java   | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/geode/blob/433e84e7/geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneService.java
----------------------------------------------------------------------
diff --git a/geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneService.java b/geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneService.java
index e3968e6..3df9ff8 100644
--- a/geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneService.java
+++ b/geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneService.java
@@ -30,7 +30,8 @@ import java.util.concurrent.TimeUnit;
  * entries are updated in the associated regions.
  *
  * <p>
- * To obtain an instance of LuceneService, use {@link LuceneServiceProvider#get(GemFireCache)}.
+ * To obtain an instance of LuceneService, use
+ * {@link LuceneServiceProvider#get(GemFireCache cache)}.
  * </p>
  * <p>
  * Lucene indexes can be created using gfsh, xml, or the java API. Below is an example of creating a
@@ -41,7 +42,7 @@ import java.util.concurrent.TimeUnit;
  * <pre>
  * {
  *   &#64;code
-*       luceneService.createIndexFactory()
+ *       luceneService.createIndexFactory()
  *        .addField("name")
  *        .addField("zipcode")
  *        .addField("email", new KeywordAnalyzer())
@@ -51,7 +52,7 @@ import java.util.concurrent.TimeUnit;
  * <p>
  * You can also specify what {@link Analyzer} to use for each field. In the example above, email is
  * being tokenized with the KeywordAnalyzer so it is treated as a single word. The default analyzer
- * if non is specified is the {@link StandardAnalyzer}
+ * if none is specified is the {@link StandardAnalyzer}.
  * </p>
  * 
  *
@@ -68,7 +69,7 @@ import java.util.concurrent.TimeUnit;
  *   &#64;code
  *   LuceneQuery query = luceneService.createLuceneQueryFactory().setLimit(200).create(indexName,
  *       regionName, "name:John AND zipcode:97006", defaultField);
- *   Collection<Object> results = query.findValues();
+ *   Collection results = query.findValues();
  * }
  * </pre>
  *