Add some more documentation to TemplateQueryParser

Relates to #4879
elastic · Apr 24, 2014 · dd75f3a · dd75f3a
1 parent cade646
commit dd75f3a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/main/java/org/elasticsearch/index/query/TemplateQueryParser.java b/src/main/java/org/elasticsearch/index/query/TemplateQueryParser.java
@@ -56,6 +56,12 @@ public String[] names() {
         return new String[] {NAME};
     }
 
+    /**
+     * Parses the template query replacing template parameters with provided values.
+     * Handles both submitting the template as part of the request as well as
+     * referencing only the template name.
+     * @param parseContext parse context containing the templated query.
+     */
     @Override
     @Nullable
     public Query parse(QueryParseContext parseContext) throws IOException {