org.apache.lucene.queryparser.xml javadocs/examples [LUCENE-7034]
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 1.4k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 88
Description
It would be nice if javadocs for [CoreParser](http://lucene.apache.org/core/5_4_1/queryparser/org/apache/lucene/queryparser/xml/CoreParser.html) mentioned/linked all the used [QueryBuilder](http://lucene.apache.org/core/5_4_1/queryparser/org/apache/lucene/queryparser/xml/QueryBuilder.html) classes and if each of those classes e.g. [BooleanQueryBuilder](http://lucene.apache.org/core/5_4_1/queryparser/org/apache/lucene/queryparser/xml/builders/BooleanQueryBuilder.html) in its javadocs had an example illustrating sub-elements and attributes used by that particular builder.
---
Migrated from [LUCENE-7034](https://issues.apache.org/jira/browse/LUCENE-7034) by Christine Poerschke (@cpoerschke), updated Aug 24 2018
Linked issues:
- [SOLR-839](https://issues.apache.org/jira/browse/SOLR-839)
- [SOLR-12695](https://issues.apache.org/jira/browse/SOLR-12695)
Contributor guide
Research direction
Start with the linked CoreParser and QueryBuilder Javadocs, then review the BooleanQueryBuilder example as a model for the other referenced builders. Document all QueryBuilder classes used by CoreParser and add builder-specific examples showing their sub-elements and attributes; the Javadocs should provide the requested links and examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100