[
https://issues.apache.org/jira/browse/IGNITE-4841?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16704586#comment-16704586
]
ASF GitHub Bot commented on IGNITE-4841:
----------------------------------------
GitHub user AMashenkov opened a pull request:
https://github.com/apache/ignite/pull/5539
IGNITE-4841: Improve javadoc for Ignite Query classes.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/gridgain/apache-ignite ignite-4841
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/ignite/pull/5539.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #5539
----
commit e5dbf64337885175cd2b2b66310d1e01f0390d22
Author: Andrey V. Mashenkov <andrey.mashenkov@...>
Date: 2018-11-30T07:23:50Z
IGNITE-4841: Fix javadoc.
----
> Improve TEXT Query Documentation
> --------------------------------
>
> Key: IGNITE-4841
> URL: https://issues.apache.org/jira/browse/IGNITE-4841
> Project: Ignite
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 1.9
> Reporter: Daniel Siviter
> Assignee: Andrew Mashenkov
> Priority: Major
> Labels: full-text-search, javadoc
> Fix For: 2.8
>
>
> The documentation for Full TEXT Queries is thin at best:
> * What syntax does it use?
> * ...is it the full [Lucene Classic Query Parser
> Syntax|https://lucene.apache.org/core/6_3_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html]?
> * ...if so how does the syntax map to the {{@QueryTextField}} annotation?
> * How is Lucene analyser customisation performed?
> * What version is supported? (looks like 3.5.0 which is pretty old, latest is
> 6.4.1)
> * The
> [{{@QueryTextField}}|https://ignite.apache.org/releases/latest/javadoc/org/apache/ignite/cache/query/annotations/QueryTextField.html]
> JavaDoc refers to
> [{{CacheQuery}}|https://ignite.apache.org/releases/latest/javadoc/org/apache/ignite/internal/processors/cache/query/CacheQuery.html]
> but strangely this doesn't even appear in the official JavaDoc. It is
> because it's an 'internal' class?
> It's mentioned multiple times as a feature, but doesn't look like much of
> Lucene can actually be utilised so clarifications would help greatly.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
