lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nightowl...@apache.org
Subject [07/11] lucenenet git commit: Preliminary conversion of JavaDocs to Markdown
Date Thu, 14 Sep 2017 05:48:28 GMT
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Core/Processors/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Core/Processors/package.md b/src/Lucene.Net.QueryParser/Flexible/Core/Processors/package.md
new file mode 100644
index 0000000..f2c74e8
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Core/Processors/package.md
@@ -0,0 +1,33 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Interfaces and implementations used by query node processors
+
+## Query Node Processors
+
+ The package <tt>org.apache.lucene.queryParser.processors</tt> contains interfaces that should be implemented by every query node processor. 
+
+ The interface that every query node processor should implement is [](xref:Lucene.Net.QueryParsers.Flexible.Core.Processors.QueryNodeProcessor). 
+
+ A query node processor should be used to process a [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) tree. [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) trees can be programmatically created or generated by a text parser. See [](xref:Lucene.Net.QueryParsers.Flexible.Core.Parser) for more details about text parsers. 
+
+ A query node processor should be used to process a [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) tree. [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) trees can be programmatically created or generated by a text parser. See [](xref:Lucene.Net.QueryParsers.Flexible.Core.Parser) for more details about text parsers. 
+
+ A pipeline of processors can be assembled using [](xref:Lucene.Net.QueryParsers.Flexible.Core.Processors.QueryNodeProcessorPipeline). 
+
+ Implementors may want to extend [](xref:Lucene.Net.QueryParsers.Flexible.Core.Processors.QueryNodeProcessorImpl), which simplifies the implementation, because it walks automatically the [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode). See [](xref:Lucene.Net.QueryParsers.Flexible.Core.Processors.QueryNodeProcessorImpl) for more details. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Core/Util/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Core/Util/package.md b/src/Lucene.Net.QueryParser/Flexible/Core/Util/package.md
new file mode 100644
index 0000000..e784749
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Core/Util/package.md
@@ -0,0 +1,23 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Utility classes to used with the Query Parser.
+
+## Utility classes to used with the Query Parser
+
+ This package contains utility classes used with the query parsers. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Core/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Core/package.md b/src/Lucene.Net.QueryParser/Flexible/Core/package.md
new file mode 100644
index 0000000..e2972ce
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Core/package.md
@@ -0,0 +1,37 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Core classes of the flexible query parser framework.
+
+## Flexible Query Parser
+
+ This package contains the necessary classes to implement a query parser. 
+
+ A query parser is divided in at least 2 phases, text parsing and query building, and one optional phase called query processing. 
+
+### First Phase: Text Parsing
+
+ The text parsing phase is performed by a text parser, which implements [](xref:Lucene.Net.QueryParsers.Flexible.Core.Parser.SyntaxParser) interface. A text parser is responsible to get a query string and convert it to a [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) tree, which is an object structure that represents the elements defined in the query string. 
+
+### Second (optional) Phase: Query Processing
+
+ The query processing phase is performed by a query processor, which implements [](xref:Lucene.Net.QueryParsers.Flexible.Core.Processors.QueryNodeProcessor). A query processor is responsible to perform any processing on a [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) tree. This phase is optional and is used only if an extra processing, validation, query expansion, etc needs to be performed in a [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) tree. The [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) tree can be either be generated by a text parser or programmatically created. 
+
+### Third Phase: Query Building
+
+ The query building phase is performed by a query builder, which implements [](xref:Lucene.Net.QueryParsers.Flexible.Core.Builders.QueryBuilder). A query builder is responsible to convert a [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) tree into an arbitrary object, which is usually used to be executed against a search index. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Messages/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Messages/package.md b/src/Lucene.Net.QueryParser/Flexible/Messages/package.md
new file mode 100644
index 0000000..2280bca
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Messages/package.md
@@ -0,0 +1,31 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+For Native Language Support (NLS), system of software internationalization.
+
+## NLS message API
+
+ This utility API, adds support for NLS messages in the apache code. It is currently used by the lucene "New Flexible Query PArser". 
+
+ Features: 1. Message reference in the code, using static Strings 2. Message resource validation at class load time, for easier debugging 3. Allows for message IDs to be re-factored using eclipse or other code re-factor tools 4. Allows for reference count on messages, just like code 5. Lazy loading of Message Strings 6. Normal loading Message Strings 
+
+ Lazy loading of Message Strings public class MessagesTestBundle extends NLS { private static final String BUNDLE_NAME = MessagesTestBundle.class.getName(); private MessagesTestBundle() { // should never be instantiated } static { // register all string ids with NLS class and initialize static string // values NLS.initializeMessages(BUNDLE_NAME, MessagesTestBundle.class); } // static string must match the strings in the property files. public static String Q0001E_INVALID_SYNTAX; public static String Q0004E_INVALID_SYNTAX_ESCAPE_UNICODE_TRUNCATION; // this message is missing from the properties file public static String Q0005E_MESSAGE_NOT_IN_BUNDLE; } // Create a message reference Message invalidSyntax = new MessageImpl(MessagesTestBundle.Q0001E_INVALID_SYNTAX, "XXX"); // Do other stuff in the code... // when is time to display the message to the user or log the message on a file // the message is loaded from the correct bundle String message1 = invalidSyntax.getLocalizedMessage(); S
 tring message2 = invalidSyntax.getLocalizedMessage(Locale.JAPANESE); 
+
+ Normal loading of Message Strings String message1 = NLS.getLocalizedMessage(MessagesTestBundle.Q0004E_INVALID_SYNTAX_ESCAPE_UNICODE_TRUNCATION); String message2 = NLS.getLocalizedMessage(MessagesTestBundle.Q0004E_INVALID_SYNTAX_ESCAPE_UNICODE_TRUNCATION, Locale.JAPANESE); 
+
+ The org.apache.lucene.messages.TestNLS junit contains several other examples. The TestNLS java code is available from the Apache Lucene code repository. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Precedence/Processors/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Precedence/Processors/package.md b/src/Lucene.Net.QueryParser/Flexible/Precedence/Processors/package.md
new file mode 100644
index 0000000..b9c02c9
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Precedence/Processors/package.md
@@ -0,0 +1,27 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Processors used by Precedence Query Parser
+
+## Lucene Precedence Query Parser Processors
+
+ This package contains the 2 [](xref:Lucene.Net.QueryParsers.Flexible.Core.Processors.QueryNodeProcessor)s used by [](xref:Lucene.Net.QueryParsers.Flexible.Precedence.PrecedenceQueryParser). 
+
+ [](xref:Lucene.Net.QueryParsers.Flexible.Precedence.Processors.BooleanModifiersQueryNodeProcessor): this processor is used to apply [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.ModifierQueryNode)s on [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.BooleanQueryNode) children according to the boolean type or the default operator. 
+
+ [](xref:Lucene.Net.QueryParsers.Flexible.Precedence.Processors.PrecedenceQueryNodeProcessorPipeline): this processor pipeline is used by [](xref:Lucene.Net.QueryParsers.Flexible.Precedence.PrecedenceQueryParser). It extends [](xref:Lucene.Net.QueryParsers.Flexible.Standard.Processors.StandardQueryNodeProcessorPipeline) and rearrange the pipeline so the boolean precedence is processed correctly. Check [](xref:Lucene.Net.QueryParsers.Flexible.Precedence.Processors.PrecedenceQueryNodeProcessorPipeline) for more details. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Precedence/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Precedence/package.md b/src/Lucene.Net.QueryParser/Flexible/Precedence/package.md
new file mode 100644
index 0000000..ebf4a0f
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Precedence/package.md
@@ -0,0 +1,25 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Precedence Query Parser Implementation
+
+## Lucene Precedence Query Parser
+
+ The Precedence Query Parser extends the Standard Query Parser and enables the boolean precedence. So, the query <a AND b OR c AND d> is parsed to <(+a +b) (+c +d)> instead of <+a +b +c +d>. 
+
+ Check [](xref:Lucene.Net.QueryParsers.Flexible.Standard.StandardQueryParser) for more details about the supported syntax and query parser functionalities. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Standard/Builders/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Standard/Builders/package.md b/src/Lucene.Net.QueryParser/Flexible/Standard/Builders/package.md
new file mode 100644
index 0000000..7bb2656
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Standard/Builders/package.md
@@ -0,0 +1,25 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Standard Lucene Query Node Builders.
+
+## Standard Lucene Query Node Builders
+
+ The package org.apache.lucene.queryparser.flexible.standard.builders contains all the builders needed to build a Lucene Query object from a query node tree. These builders expect the query node tree was already processed by the [](xref:Lucene.Net.QueryParsers.Flexible.Standard.Processors.StandardQueryNodeProcessorPipeline). 
+
+ [](xref:Lucene.Net.QueryParsers.Flexible.Standard.Builders.StandardQueryTreeBuilder) is a builder that already contains a defined map that maps each QueryNode object with its respective builder. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Standard/Config/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Standard/Config/package.md b/src/Lucene.Net.QueryParser/Flexible/Standard/Config/package.md
new file mode 100644
index 0000000..906af8d
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Standard/Config/package.md
@@ -0,0 +1,25 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Standard Lucene Query Configuration.
+
+## Standard Lucene Query Configuration
+
+ The package org.apache.lucene.queryparser.flexible.standard.config contains the Lucene query configuration handler (StandardQueryConfigHandler). This configuration handler reproduces almost everything that could be set on the old query parser. 
+
+ StandardQueryConfigHandler is the class that should be used to configure the StandardQueryNodeProcessorPipeline. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Standard/Nodes/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Standard/Nodes/package.md b/src/Lucene.Net.QueryParser/Flexible/Standard/Nodes/package.md
new file mode 100644
index 0000000..1e3eccd
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Standard/Nodes/package.md
@@ -0,0 +1,23 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Standard Lucene Query Nodes.
+
+## Standard Lucene Query Nodes
+
+ The package org.apache.lucene.queryparser.flexible.standard.nodes contains QueryNode classes that are used specifically for Lucene query node tree. Any other generic QueryNode is defined under org.apache.lucene.queryParser.nodes. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/package.md b/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/package.md
new file mode 100644
index 0000000..3cfe758
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/package.md
@@ -0,0 +1,25 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Lucene Query Parser.
+
+## Lucene Query Parser
+
+ The package org.apache.lucene.queryparser.flexible.standard.parser contains the query parser. 
+
+ This text parser only performs the syntax validation and creates an QueryNode tree from a query string. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Standard/Processors/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Standard/Processors/package.md b/src/Lucene.Net.QueryParser/Flexible/Standard/Processors/package.md
new file mode 100644
index 0000000..bfe1447
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Standard/Processors/package.md
@@ -0,0 +1,25 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Lucene Query Node Processors.
+
+## Lucene Query Node Processors
+
+ The package org.apache.lucene.queryparser.flexible.standard.processors contains every processor needed to assembly a pipeline that modifies the query node tree according to the actual Lucene queries. 
+
+ These processors are already assembled correctly in the StandardQueryNodeProcessorPipeline. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Flexible/Standard/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Standard/package.md b/src/Lucene.Net.QueryParser/Flexible/Standard/package.md
new file mode 100644
index 0000000..e011c86
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Flexible/Standard/package.md
@@ -0,0 +1,27 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Implementation of the {@linkplain org.apache.lucene.queryparser.classic Lucene classic query parser} using the flexible query parser frameworks
+
+## Lucene Flexible Query Parser Implementation
+
+ The old Lucene query parser used to have only one class that performed all the parsing operations. In the new query parser structure, the parsing was divided in 3 steps: parsing (syntax), processing (semantic) and building. 
+
+ The classes contained in the package org.apache.lucene.queryParser.standard are used to reproduce the same behavior as the old query parser. 
+
+ Check [](xref:Lucene.Net.QueryParsers.Flexible.Standard.StandardQueryParser) to quick start using the Lucene query parser. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Simple/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Simple/package.md b/src/Lucene.Net.QueryParser/Simple/package.md
new file mode 100644
index 0000000..2a16078
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Simple/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+    A simple query parser for human-entered queries.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Surround/Parser/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Surround/Parser/package.md b/src/Lucene.Net.QueryParser/Surround/Parser/package.md
new file mode 100644
index 0000000..3f349a0
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Surround/Parser/package.md
@@ -0,0 +1,22 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+    This package contains the QueryParser.jj source file for the Surround parser.
+
+    Parsing the text of a query results in a SrndQuery in the
+    org.apache.lucene.queryparser.surround.query package.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Surround/Query/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Surround/Query/package.md b/src/Lucene.Net.QueryParser/Surround/Query/package.md
new file mode 100644
index 0000000..2206bf4
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Surround/Query/package.md
@@ -0,0 +1,26 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+    This package contains SrndQuery and its subclasses.
+
+    The parser in the org.apache.lucene.queryparser.surround.parser package
+    normally generates a SrndQuery.
+
+    For searching an org.apache.lucene.search.Query is provided by
+    the SrndQuery.makeLuceneQueryField method.
+    For this, TermQuery, BooleanQuery and SpanQuery are used from Lucene.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Xml/Builders/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Xml/Builders/package.md b/src/Lucene.Net.QueryParser/Xml/Builders/package.md
new file mode 100644
index 0000000..fb6e23f
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Xml/Builders/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+XML Parser factories for different Lucene Query/Filters.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/Xml/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Xml/package.md b/src/Lucene.Net.QueryParser/Xml/package.md
new file mode 100644
index 0000000..481b325
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/Xml/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Parser that produces Lucene Query objects from XML streams.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.QueryParser/overview.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/overview.md b/src/Lucene.Net.QueryParser/overview.md
new file mode 100644
index 0000000..d572721
--- /dev/null
+++ b/src/Lucene.Net.QueryParser/overview.md
@@ -0,0 +1,141 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  -->
+
+    <title>
+      QueryParsers
+    </title>
+
+  Apache Lucene QueryParsers.
+
+  This module provides a number of queryparsers:
+
+*   [Classic](#classic)
+     [Analyzing](#analyzing)
+     [Complex Phrase](#complexphrase)
+     [Extendable](#extendable)
+     [Flexible](#flexible)
+     [Surround](#surround)
+     [XML](#xml)
+
+* * *
+
+## [Classic]()
+
+  A Simple Lucene QueryParser implemented with JavaCC.
+
+## [Analyzing]()
+
+  QueryParser that passes Fuzzy-, Prefix-, Range-, and WildcardQuerys through the given analyzer.
+
+## [Complex Phrase]()
+
+  QueryParser which permits complex phrase query syntax eg "(john jon jonathan~) peters*"
+
+## [Extendable]()
+
+  Extendable QueryParser provides a simple and flexible extension mechanism by overloading query field names.
+
+## [Flexible]()
+
+ This project contains the new Lucene query parser implementation, which matches the syntax of the core QueryParser but offers a more modular architecture to enable customization. 
+
+ It's currently divided in 2 main packages: * [](xref:Lucene.Net.QueryParsers.Flexible.Core): it contains the query parser API classes, which should be extended by query parser implementations. * [](xref:Lucene.Net.QueryParsers.Flexible.Standard): it contains the current Lucene query parser implementation using the new query parser API. 
+
+### Features
+
+1.  Full support for boolean logic (not enabled)
+2.  QueryNode Trees - support for several syntaxes, 
+            that can be converted into similar syntax QueryNode trees.
+3.  QueryNode Processors - Optimize, validate, rewrite the 
+            QueryNode trees
+4.  Processors Pipelines - Select your favorite Processor
+		    and build a processor pipeline, to implement the features you need
+5.  Config Interfaces - Allow the consumer of the Query Parser to implement
+            a diff Config Handler Objects to suite their needs.
+6.  Standard Builders - convert QueryNode's into several lucene 
+            representations. Supported conversion is using a 2.4 compatible logic
+7.  QueryNode tree's can be converted to a lucene 2.4 syntax string, using toQueryString
+
+### Design
+
+ This new query parser was designed to have very generic architecture, so that it can be easily used for different products with varying query syntaxes. This code is much more flexible and extensible than the Lucene query parser in 2.4.X. 
+
+ The new query parser goal is to separate syntax and semantics of a query. E.g. 'a AND b', '+a +b', 'AND(a,b)' could be different syntaxes for the same query. It distinguishes the semantics of the different query components, e.g. whether and how to tokenize/lemmatize/normalize the different terms or which Query objects to create for the terms. It allows to write a parser with a new syntax, while reusing the underlying semantics, as quickly as possible. 
+
+ The query parser has three layers and its core is what we call the QueryNode tree. It is a tree that initially represents the syntax of the original query, e.g. for 'a AND b': 
+
+          AND
+         /   \
+        A     B
+
+ The three layers are: 
+
+<dl>
+<dt>QueryParser</dt>
+<dd>
+This layer is the text parsing layer which simply transforms the
+query text string into a [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) tree. Every text parser
+must implement the interface [](xref:Lucene.Net.QueryParsers.Flexible.Core.Parser.SyntaxParser).
+Lucene default implementations implements it using JavaCC.
+</dd>
+
+<dt>QueryNodeProcessor</dt>
+<dd>The query node processors do most of the work. It is in fact a
+configurable chain of processors. Each processors can walk the tree and
+modify nodes or even the tree's structure. That makes it possible to
+e.g. do query optimization before the query is executed or to tokenize
+terms.
+</dd>
+
+<dt>QueryBuilder</dt>
+<dd>
+The third layer is a configurable map of builders, which map [](xref:Lucene.Net.QueryParsers.Flexible.Core.Nodes.QueryNode) types to its specific 
+builder that will transform the QueryNode into Lucene Query object.
+</dd>
+
+</dl>
+
+ Furthermore, the query parser uses flexible configuration objects. It also uses message classes that allow to attach resource bundles. This makes it possible to translate messages, which is an important feature of a query parser. 
+
+ This design allows to develop different query syntaxes very quickly. 
+
+### StandardQueryParser and QueryParserWrapper
+
+The classic Lucene query parser is located under
+[](xref:Lucene.Net.QueryParsers.Classic).
+
+To make it simpler to use the new query parser 
+the class [](xref:Lucene.Net.QueryParsers.Flexible.Standard.StandardQueryParser) may be helpful,
+specially for people that do not want to extend the Query Parser.
+It uses the default Lucene query processors, text parser and builders, so
+you don't need to worry about dealing with those.
+
+[](xref:Lucene.Net.QueryParsers.Flexible.Standard.StandardQueryParser) usage:
+
+          StandardQueryParser qpHelper = new StandardQueryParser();
+          StandardQueryConfigHandler config =  qpHelper.getQueryConfigHandler();
+          config.setAllowLeadingWildcard(true);
+          config.setAnalyzer(new WhitespaceAnalyzer());
+          Query query = qpHelper.parse("apache AND lucene", "defaultField");
+
+## [Surround]()
+
+ A QueryParser that supports the Span family of queries as well as pre and infix notation. 
+
+## [XML]()
+
+A QueryParser that produces Lucene Query objects from XML streams.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Replicator/Http/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Replicator/Http/package.md b/src/Lucene.Net.Replicator/Http/package.md
new file mode 100644
index 0000000..616b10a
--- /dev/null
+++ b/src/Lucene.Net.Replicator/Http/package.md
@@ -0,0 +1,18 @@
+<!-- 
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# HTTP replication implementation
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Replicator/overview.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Replicator/overview.md b/src/Lucene.Net.Replicator/overview.md
new file mode 100644
index 0000000..f52ce85
--- /dev/null
+++ b/src/Lucene.Net.Replicator/overview.md
@@ -0,0 +1,22 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+    <title>
+      replicator
+    </title>
+
+  Provides index files replication capabilities.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Replicator/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Replicator/package.md b/src/Lucene.Net.Replicator/package.md
new file mode 100644
index 0000000..a628226
--- /dev/null
+++ b/src/Lucene.Net.Replicator/package.md
@@ -0,0 +1,64 @@
+<!-- 
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Files replication framework
+
+	The
+	[Replicator](Replicator.html) allows replicating files between a server and client(s). Producers publish
+	[revisions](Revision.html) and consumers update to the latest revision available.
+	[ReplicationClient](ReplicationClient.html) is a helper utility for performing the update operation. It can
+	be invoked either
+	[manually](ReplicationClient.html#updateNow()) or periodically by
+	[starting an update thread](ReplicationClient.html#startUpdateThread(long, java.lang.String)).
+	[HttpReplicator](http/HttpReplicator.html) can be used to replicate revisions by consumers that reside on
+	a different node than the producer.
+
+	The replication framework supports replicating any type of files, with built-in support for a single search index as
+	well as an index and taxonomy pair. For a single index, the application should publish an
+	[IndexRevision](IndexRevision.html) and set
+	[IndexReplicationHandler](IndexReplicationHandler.html) on the client. For an index and taxonomy pair, the
+	application should publish an [IndexAndTaxonomyRevision](IndexAndTaxonomyRevision.html) and set 
+	[IndexAndTaxonomyReplicationHandler](IndexAndTaxonomyReplicationHandler.html) on the client.
+
+	When the replication client detects that there is a newer revision available, it copies the files of the revision and
+	then invokes the handler to complete the operation (e.g. copy the files to the index directory, fsync them, reopen an
+	index reader etc.). By default, only files that do not exist in the handler's
+	[current revision files](ReplicationClient.ReplicationHandler.html#currentRevisionFiles()) are copied,
+	however this can be overridden by extending the client.
+
+	An example usage of the Replicator:
+
+    // ++++++++++++++ SERVER SIDE ++++++++++++++ // 
+    IndexWriter publishWriter; // the writer used for indexing
+    Replicator replicator = new LocalReplicator();
+    replicator.publish(new IndexRevision(publishWriter));
+
+    // ++++++++++++++ CLIENT SIDE ++++++++++++++ // 
+    // either LocalReplictor, or HttpReplicator if client and server are on different nodes
+    Replicator replicator;
+
+    // callback invoked after handler finished handling the revision and e.g. can reopen the reader.
+    Callable<Boolean> callback = null; // can also be null if no callback is needed
+    ReplicationHandler handler = new IndexReplicationHandler(indexDir, callback);
+    SourceDirectoryFactory factory = new PerSessionDirectoryFactory(workDir);
+    ReplicationClient client = new ReplicationClient(replicator, handler, factory);
+
+    // invoke client manually
+    client.updateNow();
+
+    // or, periodically
+    client.startUpdateThread(100); // check for update every 100 milliseconds
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Sandbox/Queries/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Sandbox/Queries/package.md b/src/Lucene.Net.Sandbox/Queries/package.md
new file mode 100644
index 0000000..ed6f074
--- /dev/null
+++ b/src/Lucene.Net.Sandbox/Queries/package.md
@@ -0,0 +1,18 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Additional queries (some may have caveats or limitations)
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Sandbox/overview.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Sandbox/overview.md b/src/Lucene.Net.Sandbox/overview.md
new file mode 100644
index 0000000..bcbd313
--- /dev/null
+++ b/src/Lucene.Net.Sandbox/overview.md
@@ -0,0 +1,22 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  -->
+
+    <title>
+      Sandbox
+    </title>
+
+  Sandbox
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Spatial/Prefix/Tree/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Prefix/Tree/package.md b/src/Lucene.Net.Spatial/Prefix/Tree/package.md
new file mode 100644
index 0000000..59c407a
--- /dev/null
+++ b/src/Lucene.Net.Spatial/Prefix/Tree/package.md
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+The Spatial Prefix package supports spatial indexing by index-time tokens
+where adding characters to a string gives greater resolution.
+
+Potential Implementations include:
+
+*   http://en.wikipedia.org/wiki/Quadtree
+http://en.wikipedia.org/wiki/Geohash
+http://healpix.jpl.nasa.gov/
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Spatial/Prefix/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Prefix/package.md b/src/Lucene.Net.Spatial/Prefix/package.md
new file mode 100644
index 0000000..0aab8dc
--- /dev/null
+++ b/src/Lucene.Net.Spatial/Prefix/package.md
@@ -0,0 +1,18 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Prefix Tree Strategy
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Spatial/Query/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Query/package.md b/src/Lucene.Net.Spatial/Query/package.md
new file mode 100644
index 0000000..27743b5
--- /dev/null
+++ b/src/Lucene.Net.Spatial/Query/package.md
@@ -0,0 +1,18 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Spatial Query options useful for client side requests
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Spatial/Serialized/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Serialized/package.md b/src/Lucene.Net.Spatial/Serialized/package.md
new file mode 100644
index 0000000..b576be0
--- /dev/null
+++ b/src/Lucene.Net.Spatial/Serialized/package.md
@@ -0,0 +1,18 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  -->
+
+Strategies that serialize the shape (non-indexed).
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Spatial/Util/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Util/package.md b/src/Lucene.Net.Spatial/Util/package.md
new file mode 100644
index 0000000..f9ff6bd
--- /dev/null
+++ b/src/Lucene.Net.Spatial/Util/package.md
@@ -0,0 +1,18 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Various spatial utilities.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Spatial/Vector/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Vector/package.md b/src/Lucene.Net.Spatial/Vector/package.md
new file mode 100644
index 0000000..52cf3da
--- /dev/null
+++ b/src/Lucene.Net.Spatial/Vector/package.md
@@ -0,0 +1,18 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Spatial strategy that uses two fields.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Spatial/overview.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/overview.md b/src/Lucene.Net.Spatial/overview.md
new file mode 100644
index 0000000..ebf20d2
--- /dev/null
+++ b/src/Lucene.Net.Spatial/overview.md
@@ -0,0 +1,26 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# The Spatial Module for Apache Lucene
+
+ The spatial module is new to Lucene 4, replacing the old "contrib" module that came before it. The principle interface to the module is a [](xref:Lucene.Net.Spatial.SpatialStrategy) which encapsulates an approach to indexing and searching based on shapes. Different Strategies have different features and performance profiles, which are documented at each Strategy implementation class level. 
+
+ For some sample code showing how to use the API, see SpatialExample.java in the tests. 
+
+ The spatial module uses [Spatial4j](https://github.com/spatial4j/spatial4j) heavily. Spatial4j is an ASL licensed library with these capabilities: * Provides shape implementations, namely point, rectangle, and circle. Both geospatial contexts and plain 2D Euclidean/Cartesian contexts are supported. With an additional dependency, it adds polygon and other geometry shape support via integration with [JTS Topology Suite](http://sourceforge.net/projects/jts-topo-suite/). This includes dateline wrap support. * Shape parsing and serialization, including [Well-Known Text (WKT)](http://en.wikipedia.org/wiki/Well-known_text) (via JTS). * Distance and other spatial related math calculations. 
+
+ Historical note: The new spatial module was once known as Lucene Spatial Playground (LSP) as an external project. In ~March 2012, LSP split into this new module as part of Lucene and Spatial4j externally. A large chunk of the LSP implementation originated as SOLR-2155 which uses trie/prefix-tree algorithms with a geohash encoding. That approach is implemented in [](xref:Lucene.Net.Spatial.Prefix.RecursivePrefixTreeStrategy) today. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Spatial/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/package.md b/src/Lucene.Net.Spatial/package.md
new file mode 100644
index 0000000..8628162
--- /dev/null
+++ b/src/Lucene.Net.Spatial/package.md
@@ -0,0 +1,18 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Lucene spatial search
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Suggest/Spell/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Spell/package.md b/src/Lucene.Net.Suggest/Spell/package.md
new file mode 100644
index 0000000..b75ff4b
--- /dev/null
+++ b/src/Lucene.Net.Suggest/Spell/package.md
@@ -0,0 +1,20 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Suggest alternate spellings for words.
+Also see [the spell checker Wiki page](http://wiki.apache.org/jakarta-lucene/SpellChecker).
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Suggest/Suggest/Analyzing/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Analyzing/package.md b/src/Lucene.Net.Suggest/Suggest/Analyzing/package.md
new file mode 100644
index 0000000..644838d
--- /dev/null
+++ b/src/Lucene.Net.Suggest/Suggest/Analyzing/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Analyzer based autosuggest.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Suggest/Suggest/Fst/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Fst/package.md b/src/Lucene.Net.Suggest/Suggest/Fst/package.md
new file mode 100644
index 0000000..fea85da
--- /dev/null
+++ b/src/Lucene.Net.Suggest/Suggest/Fst/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Finite-state based autosuggest.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Suggest/Suggest/Jaspell/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Jaspell/package.md b/src/Lucene.Net.Suggest/Suggest/Jaspell/package.md
new file mode 100644
index 0000000..4f126cf
--- /dev/null
+++ b/src/Lucene.Net.Suggest/Suggest/Jaspell/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+JaSpell-based autosuggest.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Suggest/Suggest/Tst/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Tst/package.md b/src/Lucene.Net.Suggest/Suggest/Tst/package.md
new file mode 100644
index 0000000..e21167c
--- /dev/null
+++ b/src/Lucene.Net.Suggest/Suggest/Tst/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Ternary Search Tree based autosuggest.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Suggest/Suggest/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/package.md b/src/Lucene.Net.Suggest/Suggest/package.md
new file mode 100644
index 0000000..0349d84
--- /dev/null
+++ b/src/Lucene.Net.Suggest/Suggest/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Support for Autocomplete/Autosuggest
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Suggest/overview.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/overview.md b/src/Lucene.Net.Suggest/overview.md
new file mode 100644
index 0000000..1b0f104
--- /dev/null
+++ b/src/Lucene.Net.Suggest/overview.md
@@ -0,0 +1,22 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+    <title>
+      suggest
+    </title>
+
+  Auto-suggest and spellchecking support.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Analysis/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Analysis/package.md b/src/Lucene.Net.TestFramework/Analysis/package.md
new file mode 100644
index 0000000..abbc244
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Analysis/package.md
@@ -0,0 +1,21 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Support for testing analysis components.
+
+ The main classes of interest are: * [](xref:Lucene.Net.Analysis.BaseTokenStreamTestCase): Highly recommended to use its helper methods, (especially in conjunction with [](xref:Lucene.Net.Analysis.MockAnalyzer) or [](xref:Lucene.Net.Analysis.MockTokenizer)), as it contains many assertions and checks to catch bugs. * [](xref:Lucene.Net.Analysis.MockTokenizer): Tokenizer for testing. Tokenizer that serves as a replacement for WHITESPACE, SIMPLE, and KEYWORD tokenizers. If you are writing a component such as a TokenFilter, its a great idea to test it wrapping this tokenizer instead for extra checks. * [](xref:Lucene.Net.Analysis.MockAnalyzer): Analyzer for testing. Analyzer that uses MockTokenizer for additional verification. If you are testing a custom component such as a queryparser or analyzer-wrapper that consumes analysis streams, its a great idea to test it with this analyzer instead. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/Asserting/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Asserting/package.md b/src/Lucene.Net.TestFramework/Codecs/Asserting/package.md
new file mode 100644
index 0000000..a704e83
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/Asserting/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Codec for testing that asserts various contracts of the codec apis.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/Bloom/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Bloom/package.md b/src/Lucene.Net.TestFramework/Codecs/Bloom/package.md
new file mode 100644
index 0000000..fc0d129
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/Bloom/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Support for generating test indexes using the BloomFilteringPostingsFormat
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/CheapBastard/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/CheapBastard/package.md b/src/Lucene.Net.TestFramework/Codecs/CheapBastard/package.md
new file mode 100644
index 0000000..e6f4a36
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/CheapBastard/package.md
@@ -0,0 +1,20 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Codec that unreasonably tries to use as little RAM as possible.
+For testing, benchmarking, API purposes only!
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/Compressing/Dummy/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Compressing/Dummy/package.md b/src/Lucene.Net.TestFramework/Codecs/Compressing/Dummy/package.md
new file mode 100644
index 0000000..257a6a6
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/Compressing/Dummy/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Dummy CompressingCodec implementation used for testing.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/Compressing/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Compressing/package.md b/src/Lucene.Net.TestFramework/Codecs/Compressing/package.md
new file mode 100644
index 0000000..08aeed5
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/Compressing/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Support for testing [](xref:Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat).
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/Lucene3x/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Lucene3x/package.md b/src/Lucene.Net.TestFramework/Codecs/Lucene3x/package.md
new file mode 100644
index 0000000..281f56e
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/Lucene3x/package.md
@@ -0,0 +1,21 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Support for generating test indexes in the Lucene 3.x index format.
+
+ NOTE: This is not a perfect simulation of the 3.x format, but its close. Particularly, indexes generated with this codec cannot actually be read with Lucene 3.x 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/Lucene40/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Lucene40/package.md b/src/Lucene.Net.TestFramework/Codecs/Lucene40/package.md
new file mode 100644
index 0000000..a98655b
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/Lucene40/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Support for testing [](xref:Lucene.Net.Codecs.Lucene40.Lucene40PostingsFormat).
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/Lucene41/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Lucene41/package.md b/src/Lucene.Net.TestFramework/Codecs/Lucene41/package.md
new file mode 100644
index 0000000..456fa6b
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/Lucene41/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Support for testing [](xref:Lucene.Net.Codecs.Lucene41.Lucene41Codec).
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/Lucene41Ords/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Lucene41Ords/package.md b/src/Lucene.Net.TestFramework/Codecs/Lucene41Ords/package.md
new file mode 100644
index 0000000..fb0ab32
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/Lucene41Ords/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Codec for testing that supports [](xref:Lucene.Net.Index.TermsEnum.Ord())
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/Lucene42/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Lucene42/package.md b/src/Lucene.Net.TestFramework/Codecs/Lucene42/package.md
new file mode 100644
index 0000000..5123560
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/Lucene42/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Support for testing [](xref:Lucene.Net.Codecs.Lucene42.Lucene42Codec).
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/Lucene45/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Lucene45/package.md b/src/Lucene.Net.TestFramework/Codecs/Lucene45/package.md
new file mode 100644
index 0000000..588c2e8
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/Lucene45/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Support for testing [](xref:Lucene.Net.Codecs.Lucene45.Lucene45Codec).
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/MockIntBlock/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/MockIntBlock/package.md b/src/Lucene.Net.TestFramework/Codecs/MockIntBlock/package.md
new file mode 100644
index 0000000..3fdfa5f
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/MockIntBlock/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Integer encoder implementations for testing.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.TestFramework/Codecs/MockRandom/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/MockRandom/package.md b/src/Lucene.Net.TestFramework/Codecs/MockRandom/package.md
new file mode 100644
index 0000000..dfafabb
--- /dev/null
+++ b/src/Lucene.Net.TestFramework/Codecs/MockRandom/package.md
@@ -0,0 +1,19 @@
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Frankenstein codec for testing that pieces together random components.
\ No newline at end of file


Mime
View raw message