lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nightowl...@apache.org
Subject [11/11] lucenenet git commit: Preliminary conversion of JavaDocs to Markdown
Date Thu, 14 Sep 2017 05:48:32 GMT
Preliminary conversion of JavaDocs to Markdown


Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/6a95ad43
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/6a95ad43
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/6a95ad43

Branch: refs/heads/master
Commit: 6a95ad434d422cf1ed2b746e2cbf5d0de633b442
Parents: 03256c3
Author: Shad Storhaug <shad@shadstorhaug.com>
Authored: Thu Sep 14 12:38:39 2017 +0700
Committer: Shad Storhaug <shad@shadstorhaug.com>
Committed: Thu Sep 14 12:38:39 2017 +0700

----------------------------------------------------------------------
 .../Analysis/Ar/package.md                      |  19 +
 .../Analysis/Bg/package.md                      |  19 +
 .../Analysis/Br/package.md                      |  19 +
 .../Analysis/Ca/package.md                      |  19 +
 .../Analysis/CharFilter/package.md              |  29 +
 .../Analysis/Cjk/package.md                     |  24 +
 .../Analysis/Ckb/package.md                     |  19 +
 .../Analysis/Cn/package.md                      |  23 +
 .../Analysis/CommonGrams/package.md             |  19 +
 .../Analysis/Compound/Hyphenation/package.md    |  18 +
 .../Analysis/Compound/package.md                | 197 +++++
 .../Analysis/Core/package.md                    |  19 +
 .../Analysis/Cz/package.md                      |  19 +
 .../Analysis/Da/package.md                      |  19 +
 .../Analysis/De/package.md                      |  19 +
 .../Analysis/El/package.md                      |  19 +
 .../Analysis/En/package.md                      |  19 +
 .../Analysis/Es/package.md                      |  19 +
 .../Analysis/Eu/package.md                      |  19 +
 .../Analysis/Fa/package.md                      |  19 +
 .../Analysis/Fi/package.md                      |  19 +
 .../Analysis/Fr/package.md                      |  19 +
 .../Analysis/Ga/package.md                      |  19 +
 .../Analysis/Gl/package.md                      |  19 +
 .../Analysis/Hi/package.md                      |  19 +
 .../Analysis/Hu/package.md                      |  19 +
 .../Analysis/Hunspell/package.md                |  21 +
 .../Analysis/Hy/package.md                      |  19 +
 .../Analysis/Id/package.md                      |  19 +
 .../Analysis/In/package.md                      |  19 +
 .../Analysis/It/package.md                      |  19 +
 .../Analysis/Lv/package.md                      |  19 +
 .../Analysis/Miscellaneous/package.md           |  19 +
 .../Analysis/NGram/package.md                   |  19 +
 .../Analysis/Nl/package.md                      |  19 +
 .../Analysis/No/package.md                      |  19 +
 .../Analysis/Path/package.md                    |  19 +
 .../Analysis/Pattern/package.md                 |  19 +
 .../Analysis/Payloads/package.md                |  25 +
 .../Analysis/Position/package.md                |  19 +
 .../Analysis/Pt/package.md                      |  19 +
 .../Analysis/Query/package.md                   |  19 +
 .../Analysis/Reverse/package.md                 |  19 +
 .../Analysis/Ro/package.md                      |  19 +
 .../Analysis/Ru/package.md                      |  19 +
 .../Analysis/Shingle/package.md                 |  19 +
 .../Analysis/Sinks/package.md                   |  27 +
 .../Analysis/Snowball/package.md                |  36 +
 .../Analysis/Standard/Std31/package.md          |  19 +
 .../Analysis/Standard/Std34/package.md          |  19 +
 .../Analysis/Standard/Std36/package.md          |  19 +
 .../Analysis/Standard/Std40/package.md          |  19 +
 .../Analysis/Standard/package.md                |  59 ++
 .../Analysis/Sv/package.md                      |  19 +
 .../Analysis/Synonym/package.md                 |  19 +
 .../Analysis/Th/package.md                      |  19 +
 .../Analysis/Tr/package.md                      |  19 +
 .../Analysis/Util/package.md                    |  19 +
 .../Analysis/Wikipedia/package.md               |  19 +
 .../Collation/TokenAttributes/package.md        |  19 +
 .../Collation/package.md                        | 106 +++
 .../Tartarus/Snowball/Ext/package.md            |  19 +
 .../Tartarus/Snowball/package.md                |  19 +
 src/Lucene.Net.Analysis.Common/overview.md      |  22 +
 .../Analysis/Icu/Segmentation/package.md        |  19 +
 .../Analysis/Icu/TokenAttributes/package.md     |  19 +
 .../Analysis/Icu/package.md                     |  19 +
 .../Collation/TokenAttributes/package.md        |  19 +
 .../Collation/package.md                        |  19 +
 src/Lucene.Net.Analysis.ICU/overview.md         | 285 +++++++
 .../Dict/package.md                             |  19 +
 .../TokenAttributes/package.md                  |  19 +
 .../Util/package.md                             |  19 +
 src/Lucene.Net.Analysis.Kuromoji/overview.md    |  26 +
 src/Lucene.Net.Analysis.Kuromoji/package.md     |  19 +
 src/Lucene.Net.Analysis.Phonetic/overview.md    |  26 +
 src/Lucene.Net.Analysis.Phonetic/package.md     |  19 +
 src/Lucene.Net.Analysis.SmartCn/HHMM/package.md |  22 +
 src/Lucene.Net.Analysis.SmartCn/overview.md     |  24 +
 src/Lucene.Net.Analysis.SmartCn/package.md      |  35 +
 .../Egothor.Stemmer/package.md                  |  19 +
 src/Lucene.Net.Analysis.Stempel/Pl/package.md   |  19 +
 .../Stempel/package.md                          |  19 +
 src/Lucene.Net.Analysis.Stempel/overview.md     | 393 ++++++++++
 .../ByTask/Feeds/package.md                     |  19 +
 .../ByTask/Programmatic/package.md              |  19 +
 .../ByTask/Stats/package.md                     |  19 +
 .../ByTask/Tasks/package.md                     |  19 +
 .../ByTask/Utils/package.md                     |  19 +
 src/Lucene.Net.Benchmark/ByTask/package.md      | 499 ++++++++++++
 .../Quality/Trec/package.md                     |  19 +
 .../Quality/Utils/package.md                    |  19 +
 src/Lucene.Net.Benchmark/Quality/package.md     |  73 ++
 src/Lucene.Net.Benchmark/Utils/package.md       |  19 +
 src/Lucene.Net.Benchmark/overview.md            |  22 +
 src/Lucene.Net.Benchmark/package.md             |  46 ++
 src/Lucene.Net.Classification/Utils/package.md  |  20 +
 src/Lucene.Net.Classification/overview.md       |  22 +
 src/Lucene.Net.Classification/package.md        |  20 +
 src/Lucene.Net.Codecs/Appending/package.md      |  19 +
 src/Lucene.Net.Codecs/BlockTerms/package.md     |  19 +
 src/Lucene.Net.Codecs/Bloom/package.md          |  19 +
 src/Lucene.Net.Codecs/DiskDV/package.md         |  19 +
 src/Lucene.Net.Codecs/IntBlock/package.md       |  19 +
 src/Lucene.Net.Codecs/Memory/package.md         |  19 +
 src/Lucene.Net.Codecs/Pulsing/package.md        |  19 +
 src/Lucene.Net.Codecs/Sep/package.md            |  19 +
 src/Lucene.Net.Codecs/SimpleText/package.md     |  19 +
 src/Lucene.Net.Codecs/overview.md               |  18 +
 src/Lucene.Net.Demo/Facet/package.md            |  19 +
 src/Lucene.Net.Demo/overview.md                 | 132 ++++
 src/Lucene.Net.Demo/package.md                  |  19 +
 src/Lucene.Net.Expressions/JS/package.md        |  35 +
 src/Lucene.Net.Expressions/overview.md          |  24 +
 src/Lucene.Net.Expressions/package.md           |  24 +
 src/Lucene.Net.Facet/Range/package.md           |  18 +
 src/Lucene.Net.Facet/SortedSet/package.md       |  18 +
 .../Taxonomy/Directory/package.md               |  18 +
 .../Taxonomy/WriterCache/package.md             |  18 +
 src/Lucene.Net.Facet/Taxonomy/package.md        |  40 +
 src/Lucene.Net.Facet/overview.md                |  20 +
 src/Lucene.Net.Facet/package.md                 |  24 +
 src/Lucene.Net.Grouping/Function/package.md     |  18 +
 src/Lucene.Net.Grouping/Term/package.md         |  18 +
 src/Lucene.Net.Grouping/overview.md             |  18 +
 src/Lucene.Net.Grouping/package.md              | 147 ++++
 src/Lucene.Net.Highlighter/Highlight/package.md |  71 ++
 .../PostingsHighlight/package.md                |  19 +
 .../VectorHighlight/package.md                  | 175 +++++
 src/Lucene.Net.Highlighter/overview.md          |  23 +
 src/Lucene.Net.Join/overview.md                 |  18 +
 src/Lucene.Net.Join/package.md                  |  58 ++
 src/Lucene.Net.Memory/overview.md               |  22 +
 src/Lucene.Net.Memory/package.md                |  22 +
 src/Lucene.Net.Misc/Document/package.md         |  18 +
 src/Lucene.Net.Misc/Index/Sorter/package.md     |  34 +
 src/Lucene.Net.Misc/Index/package.md            |  18 +
 src/Lucene.Net.Misc/Misc/package.md             |  19 +
 src/Lucene.Net.Misc/Store/package.md            |  18 +
 src/Lucene.Net.Misc/Util/Fst/package.md         |  18 +
 src/Lucene.Net.Misc/overview.md                 |  56 ++
 .../Function/DocValues/package.md               |  18 +
 .../Function/ValueSources/package.md            |  18 +
 src/Lucene.Net.Queries/Function/package.md      |  18 +
 src/Lucene.Net.Queries/Mlt/package.md           |  19 +
 src/Lucene.Net.Queries/overview.md              |  22 +
 src/Lucene.Net.Queries/package.md               |  18 +
 src/Lucene.Net.QueryParser/Analyzing/package.md |  19 +
 src/Lucene.Net.QueryParser/Classic/package.md   | 313 ++++++++
 .../ComplexPhrase/package.md                    |  19 +
 src/Lucene.Net.QueryParser/Ext/package.md       |  19 +
 .../Flexible/Core/Builders/package.md           |  23 +
 .../Flexible/Core/Config/package.md             |  27 +
 .../Flexible/Core/Messages/package.md           |  23 +
 .../Flexible/Core/Nodes/package.md              |  37 +
 .../Flexible/Core/Parser/package.md             |  23 +
 .../Flexible/Core/Processors/package.md         |  33 +
 .../Flexible/Core/Util/package.md               |  23 +
 .../Flexible/Core/package.md                    |  37 +
 .../Flexible/Messages/package.md                |  31 +
 .../Flexible/Precedence/Processors/package.md   |  27 +
 .../Flexible/Precedence/package.md              |  25 +
 .../Flexible/Standard/Builders/package.md       |  25 +
 .../Flexible/Standard/Config/package.md         |  25 +
 .../Flexible/Standard/Nodes/package.md          |  23 +
 .../Flexible/Standard/Parser/package.md         |  25 +
 .../Flexible/Standard/Processors/package.md     |  25 +
 .../Flexible/Standard/package.md                |  27 +
 src/Lucene.Net.QueryParser/Simple/package.md    |  19 +
 .../Surround/Parser/package.md                  |  22 +
 .../Surround/Query/package.md                   |  26 +
 .../Xml/Builders/package.md                     |  19 +
 src/Lucene.Net.QueryParser/Xml/package.md       |  19 +
 src/Lucene.Net.QueryParser/overview.md          | 141 ++++
 src/Lucene.Net.Replicator/Http/package.md       |  18 +
 src/Lucene.Net.Replicator/overview.md           |  22 +
 src/Lucene.Net.Replicator/package.md            |  64 ++
 src/Lucene.Net.Sandbox/Queries/package.md       |  18 +
 src/Lucene.Net.Sandbox/overview.md              |  22 +
 src/Lucene.Net.Spatial/Prefix/Tree/package.md   |  25 +
 src/Lucene.Net.Spatial/Prefix/package.md        |  18 +
 src/Lucene.Net.Spatial/Query/package.md         |  18 +
 src/Lucene.Net.Spatial/Serialized/package.md    |  18 +
 src/Lucene.Net.Spatial/Util/package.md          |  18 +
 src/Lucene.Net.Spatial/Vector/package.md        |  18 +
 src/Lucene.Net.Spatial/overview.md              |  26 +
 src/Lucene.Net.Spatial/package.md               |  18 +
 src/Lucene.Net.Suggest/Spell/package.md         |  20 +
 .../Suggest/Analyzing/package.md                |  19 +
 src/Lucene.Net.Suggest/Suggest/Fst/package.md   |  19 +
 .../Suggest/Jaspell/package.md                  |  19 +
 src/Lucene.Net.Suggest/Suggest/Tst/package.md   |  19 +
 src/Lucene.Net.Suggest/Suggest/package.md       |  19 +
 src/Lucene.Net.Suggest/overview.md              |  22 +
 .../Analysis/package.md                         |  21 +
 .../Codecs/Asserting/package.md                 |  19 +
 .../Codecs/Bloom/package.md                     |  19 +
 .../Codecs/CheapBastard/package.md              |  20 +
 .../Codecs/Compressing/Dummy/package.md         |  19 +
 .../Codecs/Compressing/package.md               |  19 +
 .../Codecs/Lucene3x/package.md                  |  21 +
 .../Codecs/Lucene40/package.md                  |  19 +
 .../Codecs/Lucene41/package.md                  |  19 +
 .../Codecs/Lucene41Ords/package.md              |  19 +
 .../Codecs/Lucene42/package.md                  |  19 +
 .../Codecs/Lucene45/package.md                  |  19 +
 .../Codecs/MockIntBlock/package.md              |  19 +
 .../Codecs/MockRandom/package.md                |  19 +
 .../Codecs/MockSep/package.md                   |  19 +
 .../Codecs/NestedPulsing/package.md             |  19 +
 .../Codecs/RAMOnly/package.md                   |  19 +
 src/Lucene.Net.TestFramework/Codecs/package.md  |  19 +
 src/Lucene.Net.TestFramework/Index/package.md   |  21 +
 src/Lucene.Net.TestFramework/Search/package.md  |  21 +
 src/Lucene.Net.TestFramework/Store/package.md   |  22 +
 .../Util/Automaton/package.md                   |  20 +
 .../Util/Fst/package.md                         |  19 +
 src/Lucene.Net.TestFramework/Util/package.md    |  20 +
 src/Lucene.Net.TestFramework/overview.md        |  18 +
 .../Analysis/TokenAttributes/package.md         |  19 +
 src/Lucene.Net/Analysis/package.md              | 780 +++++++++++++++++++
 src/Lucene.Net/Codecs/Compressing/package.md    |  19 +
 src/Lucene.Net/Codecs/Lucene3x/package.md       |  19 +
 src/Lucene.Net/Codecs/Lucene40/package.md       | 337 ++++++++
 src/Lucene.Net/Codecs/Lucene41/package.md       | 346 ++++++++
 src/Lucene.Net/Codecs/Lucene42/package.md       | 349 +++++++++
 src/Lucene.Net/Codecs/Lucene45/package.md       | 350 +++++++++
 src/Lucene.Net/Codecs/Lucene46/package.md       | 355 +++++++++
 src/Lucene.Net/Codecs/PerField/package.md       |  19 +
 src/Lucene.Net/Codecs/package.md                |  30 +
 src/Lucene.Net/Document/package.md              |  33 +
 src/Lucene.Net/Index/package.md                 |  71 ++
 src/Lucene.Net/Search/Payloads/package.md       |  27 +
 src/Lucene.Net/Search/Similarities/package.md   |  55 ++
 src/Lucene.Net/Search/Spans/package.md          |  52 ++
 src/Lucene.Net/Search/package.md                | 163 ++++
 src/Lucene.Net/Store/package.md                 |  19 +
 src/Lucene.Net/Util/Automaton/package.md        |  43 +
 src/Lucene.Net/Util/Fst/package.md              |  84 ++
 src/Lucene.Net/Util/Mutable/package.md          |  19 +
 src/Lucene.Net/Util/Packed/package.md           |  71 ++
 src/Lucene.Net/Util/package.md                  |  19 +
 src/Lucene.Net/overview.md                      | 141 ++++
 src/Lucene.Net/package.md                       |  17 +
 244 files changed, 10428 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Ar/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Ar/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Ar/package.md
new file mode 100644
index 0000000..f549644
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Ar/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 for Arabic.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Bg/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Bg/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Bg/package.md
new file mode 100644
index 0000000..97f4cb5
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Bg/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 for Bulgarian.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Br/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Br/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Br/package.md
new file mode 100644
index 0000000..029f795
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Br/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 for Brazilian Portuguese.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Ca/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Ca/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Ca/package.md
new file mode 100644
index 0000000..1b97a7c
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Ca/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 for Catalan.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/CharFilter/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/CharFilter/package.md b/src/Lucene.Net.Analysis.Common/Analysis/CharFilter/package.md
new file mode 100644
index 0000000..36682ea
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/CharFilter/package.md
@@ -0,0 +1,29 @@
+
+<!--
+ 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.
+-->
+
+ Normalization of text before the tokenizer. 
+
+ CharFilters are chainable filters that normalize text before tokenization and provide mappings between normalized text offsets and the corresponding offset in the original text. 
+
+<h2>CharFilter offset mappings</h2>
+
+ CharFilters modify an input stream via a series of substring replacements (including deletions and insertions) to produce an output stream. There are three possible replacement cases: the replacement string has the same length as the original substring; the replacement is shorter; and the replacement is longer. In the latter two cases (when the replacement has a different length than the original), one or more offset correction mappings are required. 
+
+ When the replacement is shorter than the original (e.g. when the replacement is the empty string), a single offset correction mapping should be added at the replacement's end offset in the output stream. The `cumulativeDiff` parameter to the `addOffCorrectMapping()` method will be the sum of all previous replacement offset adjustments, with the addition of the difference between the lengths of the original substring and the replacement string (a positive value). 
+
+ When the replacement is longer than the original (e.g. when the original is the empty string), you should add as many offset correction mappings as the difference between the lengths of the replacement string and the original substring, starting at the end offset the original substring would have had in the output stream. The `cumulativeDiff` parameter to the `addOffCorrectMapping()` method will be the sum of all previous replacement offset adjustments, with the addition of the difference between the lengths of the original substring and the replacement string so far (a negative value). 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Cjk/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Cjk/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Cjk/package.md
new file mode 100644
index 0000000..b4b5e73
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Cjk/package.md
@@ -0,0 +1,24 @@
+
+<!--
+ 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.
+-->
+
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+
+Analyzer for Chinese, Japanese, and Korean, which indexes bigrams. 
+This analyzer generates bigram terms, which are overlapping groups of two adjacent Han, Hiragana, Katakana, or Hangul characters.
+
+ Three analyzers are provided for Chinese, each of which treats Chinese text in a different way. * ChineseAnalyzer (in the analyzers/cn package): Index unigrams (individual Chinese characters) as a token. CJKAnalyzer (in this package): Index bigrams (overlapping groups of two adjacent Chinese characters) as tokens. SmartChineseAnalyzer (in the analyzers/smartcn package): Index words (attempt to segment Chinese text into words) as tokens. Example phrase: "我是中国人" 1. ChineseAnalyzer: 我-是-中-国-人 2. CJKAnalyzer: 我是-是中-中国-国人 3. SmartChineseAnalyzer: 我-是-中国-人 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Ckb/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Ckb/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Ckb/package.md
new file mode 100644
index 0000000..a236399
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Ckb/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 for Sorani Kurdish.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Cn/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Cn/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Cn/package.md
new file mode 100644
index 0000000..50a3555
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Cn/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.
+-->
+
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+
+Analyzer for Chinese, which indexes unigrams (individual chinese characters).
+
+ Three analyzers are provided for Chinese, each of which treats Chinese text in a different way. * StandardAnalyzer: Index unigrams (individual Chinese characters) as a token. CJKAnalyzer (in the analyzers/cjk package): Index bigrams (overlapping groups of two adjacent Chinese characters) as tokens. SmartChineseAnalyzer (in the analyzers/smartcn package): Index words (attempt to segment Chinese text into words) as tokens. Example phrase: "我是中国人" 1. StandardAnalyzer: 我-是-中-国-人 2. CJKAnalyzer: 我是-是中-中国-国人 3. SmartChineseAnalyzer: 我-是-中国-人 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/CommonGrams/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/CommonGrams/package.md b/src/Lucene.Net.Analysis.Common/Analysis/CommonGrams/package.md
new file mode 100644
index 0000000..5d0f71a
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/CommonGrams/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.
+-->
+
+Construct n-grams for frequently occurring terms and phrases.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/package.md
new file mode 100644
index 0000000..486c682
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/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.
+-->
+
+ The code for the compound word hyphenation is taken from the [Apache FOP project](http://xmlgraphics.apache.org/fop/). All credits for the hyphenation code belongs to them. 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Compound/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Compound/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Compound/package.md
new file mode 100644
index 0000000..77585b4
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Compound/package.md
@@ -0,0 +1,197 @@
+
+<!--
+ 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 filter that decomposes compound words you find in many Germanic
+languages into the word parts. This example shows what it does:
+<table border="1">
+	<tr>
+		<th>Input token stream</th>
+	</tr>
+	<tr>
+		<td>Rindfleischüberwachungsgesetz Drahtschere abba</td>
+	</tr>
+</table>
+
+<table border="1">
+	<tr>
+		<th>Output token stream</th>
+	</tr>
+	<tr>
+		<td>(Rindfleischüberwachungsgesetz,0,29)</td>
+	</tr>
+	<tr>
+		<td>(Rind,0,4,posIncr=0)</td>
+	</tr>
+	<tr>
+		<td>(fleisch,4,11,posIncr=0)</td>
+	</tr>
+	<tr>
+		<td>(überwachung,11,22,posIncr=0)</td>
+	</tr>
+	<tr>
+		<td>(gesetz,23,29,posIncr=0)</td>
+	</tr>
+	<tr>
+		<td>(Drahtschere,30,41)</td>
+	</tr>
+	<tr>
+		<td>(Draht,30,35,posIncr=0)</td>
+	</tr>
+	<tr>
+		<td>(schere,35,41,posIncr=0)</td>
+	</tr>
+	<tr>
+		<td>(abba,42,46)</td>
+	</tr>
+</table>
+
+The input token is always preserved and the filters do not alter the case of word parts. There are two variants of the
+filter available:
+
+*   *HyphenationCompoundWordTokenFilter*: it uses a
+	hyphenation grammar based approach to find potential word parts of a
+	given word.
+*   *DictionaryCompoundWordTokenFilter*: it uses a
+	brute-force dictionary-only based approach to find the word parts of a given
+	word.
+
+### Compound word token filters
+
+#### HyphenationCompoundWordTokenFilter
+
+The [](xref:Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter
+HyphenationCompoundWordTokenFilter) uses hyphenation grammars to find
+potential subwords that a worth to check against the dictionary. It can be used
+without a dictionary as well but then produces a lot of "nonword" tokens.
+The quality of the output tokens is directly connected to the quality of the
+grammar file you use. For languages like German they are quite good.
+
+##### Grammar file
+
+Unfortunately we cannot bundle the hyphenation grammar files with Lucene
+because they do not use an ASF compatible license (they use the LaTeX
+Project Public License instead). You can find the XML based grammar
+files at the
+[Objects
+For Formatting Objects](http://offo.sourceforge.net/hyphenation/index.html)
+(OFFO) Sourceforge project (direct link to download the pattern files:
+[http://downloads.sourceforge.net/offo/offo-hyphenation.zip](http://downloads.sourceforge.net/offo/offo-hyphenation.zip)
+). The files you need are in the subfolder
+*offo-hyphenation/hyph/*
+.
+
+Credits for the hyphenation code go to the
+[Apache FOP project](http://xmlgraphics.apache.org/fop/)
+.
+
+#### DictionaryCompoundWordTokenFilter
+
+The [](xref:Lucene.Net.Analysis.Compound.DictionaryCompoundWordTokenFilter
+DictionaryCompoundWordTokenFilter) uses a dictionary-only approach to
+find subwords in a compound word. It is much slower than the one that
+uses the hyphenation grammars. You can use it as a first start to
+see if your dictionary is good or not because it is much simpler in design.
+
+### Dictionary
+
+The output quality of both token filters is directly connected to the
+quality of the dictionary you use. They are language dependent of course.
+You always should use a dictionary
+that fits to the text you want to index. If you index medical text for
+example then you should use a dictionary that contains medical words.
+A good start for general text are the dictionaries you find at the
+[OpenOffice
+dictionaries](http://wiki.services.openoffice.org/wiki/Dictionaries)
+Wiki.
+
+### Which variant should I use?
+
+This decision matrix should help you:
+<table border="1">
+	<tr>
+		<th>Token filter</th>
+		<th>Output quality</th>
+		<th>Performance</th>
+	</tr>
+	<tr>
+		<td>HyphenationCompoundWordTokenFilter</td>
+		<td>good if grammar file is good – acceptable otherwise</td>
+		<td>fast</td>
+	</tr>
+	<tr>
+		<td>DictionaryCompoundWordTokenFilter</td>
+		<td>good</td>
+		<td>slow</td>
+	</tr>
+</table>
+
+### Examples
+
+      public void testHyphenationCompoundWordsDE() throws Exception {
+        String[] dict = { "Rind", "Fleisch", "Draht", "Schere", "Gesetz",
+            "Aufgabe", "Überwachung" };
+
+        Reader reader = new FileReader("de_DR.xml");
+
+        HyphenationTree hyphenator = HyphenationCompoundWordTokenFilter
+            .getHyphenationTree(reader);
+
+        HyphenationCompoundWordTokenFilter tf = new HyphenationCompoundWordTokenFilter(
+            new WhitespaceTokenizer(new StringReader(
+                "Rindfleischüberwachungsgesetz Drahtschere abba")), hyphenator,
+            dict, CompoundWordTokenFilterBase.DEFAULT_MIN_WORD_SIZE,
+            CompoundWordTokenFilterBase.DEFAULT_MIN_SUBWORD_SIZE,
+            CompoundWordTokenFilterBase.DEFAULT_MAX_SUBWORD_SIZE, false);
+
+        CharTermAttribute t = tf.addAttribute(CharTermAttribute.class);
+        while (tf.incrementToken()) {
+           System.out.println(t);
+        }
+      }
+
+      public void testHyphenationCompoundWordsWithoutDictionaryDE() throws Exception {
+        Reader reader = new FileReader("de_DR.xml");
+
+        HyphenationTree hyphenator = HyphenationCompoundWordTokenFilter
+            .getHyphenationTree(reader);
+
+        HyphenationCompoundWordTokenFilter tf = new HyphenationCompoundWordTokenFilter(
+            new WhitespaceTokenizer(new StringReader(
+                "Rindfleischüberwachungsgesetz Drahtschere abba")), hyphenator);
+
+        CharTermAttribute t = tf.addAttribute(CharTermAttribute.class);
+        while (tf.incrementToken()) {
+           System.out.println(t);
+        }
+      }
+
+      public void testDumbCompoundWordsSE() throws Exception {
+        String[] dict = { "Bil", "Dörr", "Motor", "Tak", "Borr", "Slag", "Hammar",
+            "Pelar", "Glas", "Ögon", "Fodral", "Bas", "Fiol", "Makare", "Gesäll",
+            "Sko", "Vind", "Rute", "Torkare", "Blad" };
+
+        DictionaryCompoundWordTokenFilter tf = new DictionaryCompoundWordTokenFilter(
+            new WhitespaceTokenizer(
+                new StringReader(
+                    "Bildörr Bilmotor Biltak Slagborr Hammarborr Pelarborr Glasögonfodral Basfiolsfodral Basfiolsfodralmakaregesäll Skomakare Vindrutetorkare Vindrutetorkarblad abba")),
+            dict);
+        CharTermAttribute t = tf.addAttribute(CharTermAttribute.class);
+        while (tf.incrementToken()) {
+           System.out.println(t);
+        }
+      }
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Core/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Core/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Core/package.md
new file mode 100644
index 0000000..eca4ea8
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Core/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.
+-->
+
+Basic, general-purpose analysis components.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Cz/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Cz/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Cz/package.md
new file mode 100644
index 0000000..3fab7b3
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Cz/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 for Czech.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Da/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Da/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Da/package.md
new file mode 100644
index 0000000..28f3f05
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Da/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 for Danish.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/De/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/De/package.md b/src/Lucene.Net.Analysis.Common/Analysis/De/package.md
new file mode 100644
index 0000000..b7968ae
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/De/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 for German.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/El/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/El/package.md b/src/Lucene.Net.Analysis.Common/Analysis/El/package.md
new file mode 100644
index 0000000..d3c7841
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/El/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 for Greek.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/En/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/En/package.md b/src/Lucene.Net.Analysis.Common/Analysis/En/package.md
new file mode 100644
index 0000000..3110908
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/En/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 for English.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Es/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Es/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Es/package.md
new file mode 100644
index 0000000..cae1939
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Es/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 for Spanish.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Eu/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Eu/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Eu/package.md
new file mode 100644
index 0000000..8cb763d
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Eu/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 for Basque.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Fa/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fa/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Fa/package.md
new file mode 100644
index 0000000..6b10a6a
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Fa/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 for Persian.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Fi/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fi/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Fi/package.md
new file mode 100644
index 0000000..7d645ab
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Fi/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 for Finnish.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Fr/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fr/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Fr/package.md
new file mode 100644
index 0000000..954d6dd
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Fr/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 for French.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Ga/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Ga/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Ga/package.md
new file mode 100644
index 0000000..59dfa84
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Ga/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.
+-->
+
+Analysis for Irish.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Gl/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Gl/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Gl/package.md
new file mode 100644
index 0000000..ba070bf
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Gl/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 for Galician.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Hi/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Hi/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Hi/package.md
new file mode 100644
index 0000000..4823c3d
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Hi/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 for Hindi.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Hu/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Hu/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Hu/package.md
new file mode 100644
index 0000000..a950c8b
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Hu/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 for Hungarian.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Hunspell/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Hunspell/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Hunspell/package.md
new file mode 100644
index 0000000..17bdf15
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Hunspell/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.
+  -->
+
+Stemming TokenFilter using a Java implementation of the [
+Hunspell stemming algorithm.](http://www.ldc.upenn.edu/Catalog/docs/LDC2008T01/acta04.pdf)
+
+ Dictionaries can be found on [ OpenOffice's wiki](http://wiki.services.openoffice.org/wiki/Dictionaries) 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Hy/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Hy/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Hy/package.md
new file mode 100644
index 0000000..db75f33
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Hy/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 for Armenian.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Id/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Id/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Id/package.md
new file mode 100644
index 0000000..f5fa57f
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Id/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 for Indonesian.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/In/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/In/package.md b/src/Lucene.Net.Analysis.Common/Analysis/In/package.md
new file mode 100644
index 0000000..447b2e0
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/In/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.
+-->
+
+Analysis components for Indian languages.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/It/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/It/package.md b/src/Lucene.Net.Analysis.Common/Analysis/It/package.md
new file mode 100644
index 0000000..0cc4f96
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/It/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 for Italian.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Lv/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Lv/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Lv/package.md
new file mode 100644
index 0000000..9e867b8
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Lv/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 for Latvian.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/package.md
new file mode 100644
index 0000000..5a0ef88
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/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.
+-->
+
+Miscellaneous TokenStreams
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/NGram/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/NGram/package.md b/src/Lucene.Net.Analysis.Common/Analysis/NGram/package.md
new file mode 100644
index 0000000..d98e500
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/NGram/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.
+-->
+
+Character n-gram tokenizers and filters.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Nl/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Nl/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Nl/package.md
new file mode 100644
index 0000000..769a5d0
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Nl/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 for Dutch.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/No/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/No/package.md b/src/Lucene.Net.Analysis.Common/Analysis/No/package.md
new file mode 100644
index 0000000..3680d2e
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/No/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 for Norwegian.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Path/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Path/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Path/package.md
new file mode 100644
index 0000000..5d3aa15
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Path/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.
+-->
+
+Analysis components for path-like strings such as filenames.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Pattern/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Pattern/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Pattern/package.md
new file mode 100644
index 0000000..85af377
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Pattern/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.
+-->
+
+Set of components for pattern-based (regex) analysis.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Payloads/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Payloads/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Payloads/package.md
new file mode 100644
index 0000000..bf1ec16
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Payloads/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.
+-->
+<HTML>
+<HEAD>
+    <TITLE>org.apache.lucene.analysis.payloads</TITLE>
+</HEAD>
+<BODY>
+Provides various convenience classes for creating payloads on Tokens.
+</BODY>
+</HTML>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Position/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Position/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Position/package.md
new file mode 100644
index 0000000..61e0676
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Position/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.
+-->
+
+Filter for assigning position increments.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Pt/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Pt/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Pt/package.md
new file mode 100644
index 0000000..c6180a5
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Pt/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 for Portuguese.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Query/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Query/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Query/package.md
new file mode 100644
index 0000000..0634ae9
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Query/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.
+-->
+
+Automatically filter high-frequency stopwords.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Reverse/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Reverse/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Reverse/package.md
new file mode 100644
index 0000000..4012f76
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Reverse/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.
+-->
+
+Filter to reverse token text.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Ro/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Ro/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Ro/package.md
new file mode 100644
index 0000000..a2b3c38
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Ro/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 for Romanian.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Ru/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Ru/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Ru/package.md
new file mode 100644
index 0000000..40afff5
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Ru/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 for Russian.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Shingle/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Shingle/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Shingle/package.md
new file mode 100644
index 0000000..6b78935
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Shingle/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.
+-->
+
+Word n-gram filters
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Sinks/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Sinks/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Sinks/package.md
new file mode 100644
index 0000000..d9b4794
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Sinks/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.
+-->
+<HTML>
+<HEAD>
+   <TITLE>org.apache.lucene.analysis.sinks</TITLE>
+</HEAD>
+<BODY>
+[](xref:Lucene.Net.Analysis.Sinks.TeeSinkTokenFilter) and implementations
+of [](xref:Lucene.Net.Analysis.Sinks.TeeSinkTokenFilter.SinkFilter) that
+might be useful.
+</BODY>
+</HTML>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/6a95ad43/src/Lucene.Net.Analysis.Common/Analysis/Snowball/package.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Snowball/package.md b/src/Lucene.Net.Analysis.Common/Analysis/Snowball/package.md
new file mode 100644
index 0000000..fc93a1d
--- /dev/null
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Snowball/package.md
@@ -0,0 +1,36 @@
+
+<!--
+ 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.
+-->
+
+[](xref:Lucene.Net.Analysis.TokenFilter) and [](xref:Lucene.Net.Analysis.Analyzer) implementations that use Snowball
+stemmers.
+
+ This project provides pre-compiled version of the Snowball stemmers based on revision 500 of the Tartarus Snowball repository, together with classes integrating them with the Lucene search engine. 
+
+ A few changes has been made to the static Snowball code and compiled stemmers: 
+
+*   Class SnowballProgram is made abstract and contains new abstract method stem() to avoid reflection in Lucene filter class SnowballFilter.
+*   All use of StringBuffers has been refactored to StringBuilder for speed.
+*   Snowball BSD license header has been added to the Java classes to avoid having RAT adding ASL headers.
+
+ See the Snowball [home page](http://snowball.tartarus.org/) for more information about the algorithms. 
+
+ **IMPORTANT NOTICE ON BACKWARDS COMPATIBILITY!** 
+
+ An index created using the Snowball module in Lucene 2.3.2 and below might not be compatible with the Snowball module in Lucene 2.4 or greater. 
+
+ For more information about this issue see: https://issues.apache.org/jira/browse/LUCENE-1142 
\ No newline at end of file


Mime
View raw message