diff --git a/src/Lucene.Net.Analysis.OpenNLP/overview.md b/src/Lucene.Net.Analysis.OpenNLP/overview.md index 91e08dec6c..ba4f9fc9b6 100644 --- a/src/Lucene.Net.Analysis.OpenNLP/overview.md +++ b/src/Lucene.Net.Analysis.OpenNLP/overview.md @@ -1,5 +1,5 @@ --- -uid: Lucene.Net.Analysis.OpenNLP +uid: Lucene.Net.Analysis.OpenNlp summary: *content --- diff --git a/src/Lucene.Net.Benchmark/overview.md b/src/Lucene.Net.Benchmark/overview.md index 0c0e665db2..443960778d 100644 --- a/src/Lucene.Net.Benchmark/overview.md +++ b/src/Lucene.Net.Benchmark/overview.md @@ -1,5 +1,6 @@ --- uid: Lucene.Net.Benchmarks +title: Lucene.Net.Benchmarks summary: *content --- diff --git a/src/Lucene.Net.Benchmark/package.md b/src/Lucene.Net.Benchmark/package.md index 3dcb6ad96d..eeb42d2e01 100644 --- a/src/Lucene.Net.Benchmark/package.md +++ b/src/Lucene.Net.Benchmark/package.md @@ -1,5 +1,6 @@ --- uid: Lucene.Net.Benchmarks +title: Lucene.Net.Benchmarks summary: *content --- @@ -21,24 +22,21 @@ summary: *content --> The benchmark contribution contains tools for benchmarking Lucene using standard, freely available corpora. -
- ANT will - download the corpus automatically, place it in a temp directory and then unpack it to the working.dir directory specified in the build. - The temp directory - and working directory can be safely removed after a run. However, the next time the task is run, it will need to download the files again. +ANT will +download the corpus automatically, place it in a temp directory and then unpack it to the working.dir directory specified in the build. +The temp directory +and working directory can be safely removed after a run. However, the next time the task is run, it will need to download the files again. - Classes implementing the Benchmarker interface should have a no-argument constructor if they are to be used with the Driver class. The Driver - class is provided for convenience only. Feel free to implement your own main class for your benchmarker. +Classes implementing the Benchmarker interface should have a no-argument constructor if they are to be used with the Driver class. The Driver +class is provided for convenience only. Feel free to implement your own main class for your benchmarker. - The StandardBenchmarker is meant to be just that, a standard that runs out of the box with no configuration or changes needed. - Other benchmarking classes may derive from it to provide alternate views or to take in command line options. When reporting benchmarking runs - you should state any alterations you have made. +The StandardBenchmarker is meant to be just that, a standard that runs out of the box with no configuration or changes needed. +Other benchmarking classes may derive from it to provide alternate views or to take in command line options. When reporting benchmarking runs +you should state any alterations you have made. - To run the short version of the StandardBenchmarker, call "ant run-micro-standard". This should take a minute or so to complete and give you a preliminary idea of how your change affects the code +To run the short version of the StandardBenchmarker, call "ant run-micro-standard". This should take a minute or so to complete and give you a preliminary idea of how your change affects the code - To run the long version of the StandardBenchmarker, call "ant run-standard". This takes considerably longer. +To run the long version of the StandardBenchmarker, call "ant run-standard". This takes considerably longer. - The original code for these classes was donated by Andrzej Bialecki at http://issues.apache.org/jira/browse/LUCENE-675 and has been updated by Grant Ingersoll to make some parts of the code reusable in other benchmarkers -
-
 
\ No newline at end of file +The original code for these classes was donated by Andrzej Bialecki at http://issues.apache.org/jira/browse/LUCENE-675 and has been updated by Grant Ingersoll to make some parts of the code reusable in other benchmarkers \ No newline at end of file diff --git a/src/Lucene.Net.Memory/overview.md b/src/Lucene.Net.Memory/overview.md index 43b66efb10..e5710198ca 100644 --- a/src/Lucene.Net.Memory/overview.md +++ b/src/Lucene.Net.Memory/overview.md @@ -1,6 +1,5 @@ --- -uid: Lucene.Net.Memory -title: Lucene.Net.Memory +uid: Lucene.Net.Index.Memory summary: *content --- diff --git a/src/Lucene.Net.Memory/package.md b/src/Lucene.Net.Memory/package.md index ba3830e949..4b49d0f369 100644 --- a/src/Lucene.Net.Memory/package.md +++ b/src/Lucene.Net.Memory/package.md @@ -1,6 +1,5 @@ --- -uid: Lucene.Net.Memory -title: Lucene.Net.Memory +uid: Lucene.Net.Index.Memory summary: *content --- diff --git a/src/docs/JavaDocToMarkdownConverter/DocConverter.cs b/src/docs/JavaDocToMarkdownConverter/DocConverter.cs index 40ecb5b9d3..d07227eb52 100644 --- a/src/docs/JavaDocToMarkdownConverter/DocConverter.cs +++ b/src/docs/JavaDocToMarkdownConverter/DocConverter.cs @@ -115,7 +115,7 @@ private void ConvertDoc(string inputDoc, string rootOutputDirectory) /// private static readonly Dictionary CustomConverters = new Dictionary(StringComparer.InvariantCultureIgnoreCase) { - ["Lucene.Net.Benchmark"] = new Converter(new CustomMarkdownScheme(new ElementWhitespacePrefixReplacer("div"))), + ["Lucene.Net.Benchmarks"] = new Converter(new CustomMarkdownScheme(new ElementWhitespacePrefixReplacer("div"))), ["Lucene.Net.Replicator"] = new Converter(new CustomMarkdownScheme(new AllWhitespacePrefixReplacer())) }; @@ -128,9 +128,10 @@ private void ConvertDoc(string inputDoc, string rootOutputDirectory) private static readonly Dictionary PackageNamespaceToStandalone = new Dictionary(StringComparer.InvariantCultureIgnoreCase) { ["Lucene.Net.Search.Grouping"] = "Lucene.Net.Grouping", - ["Lucene.Net.Index.Memory"] = "Lucene.Net.Memory", + ["Lucene.Net.Memory"] = "Lucene.Net.Index.Memory", ["Lucene.Net.Queryparser"] = "Lucene.Net.QueryParser", ["Lucene.Net.Testframework"] = "Lucene.Net.TestFramework", + ["Lucene.Net.Benchmark"] = "Lucene.Net.Benchmarks" }; /// @@ -142,14 +143,13 @@ private void ConvertDoc(string inputDoc, string rootOutputDirectory) "Lucene.Net", "Lucene.Net.Analysis.Common", "Lucene.Net.Analysis.Morfologik", - "Lucene.Net.Analysis.OpenNLP", "Lucene.Net.Highlighter", "Lucene.Net.Grouping", - "Lucene.Net.Memory", "Lucene.Net.QueryParser", "Lucene.Net.Sandbox", "Lucene.Net.Suggest", - "Lucene.Net.TestFramework" + "Lucene.Net.TestFramework", + "Lucene.Net.Benchmarks", }; /// @@ -157,10 +157,6 @@ private void ConvertDoc(string inputDoc, string rootOutputDirectory) /// /// /// - /// - /// If specified will add the "title" front-matter, this is used for overview.md files that are - /// standalone (not part of a real namespace) (aka conceptual files in docfx) - /// /// private string AppendYamlHeader(string ns, string fileContent) { diff --git a/websites/apidocs/docfx.json b/websites/apidocs/docfx.json index 984cbc8030..5c9c3c7090 100644 --- a/websites/apidocs/docfx.json +++ b/websites/apidocs/docfx.json @@ -416,7 +416,6 @@ "Lucene.Net.Analysis.OpenNLP/overview.md", "Lucene.Net.Highlighter/overview.md", "Lucene.Net.Grouping/package.md", - "Lucene.Net.Memory/package.md", "Lucene.Net.QueryParser/overview.md", "Lucene.Net.Sandbox/overview.md", "Lucene.Net.Suggest/overview.md", diff --git a/websites/apidocs/index.md b/websites/apidocs/index.md index cd6d4c4773..b3b84b6d9a 100644 --- a/websites/apidocs/index.md +++ b/websites/apidocs/index.md @@ -42,7 +42,7 @@ on some of the conceptual or inner details of Lucene: * [Lucene.Net](xref:Lucene.Net) - Core library * [Lucene.Net.Analysis.Common](xref:Lucene.Net.Analysis.Common) - Analyzers for indexing content in different languages and domains * [Lucene.Net.Analysis.Kuromoji](xref:Lucene.Net.Analysis.Ja) - Japanese Morphological Analyzer -* [Lucene.Net.Analysis.Morfologik](xref:Lucene.Net.Analysis.Uk) - Analyzer for dictionary stemming, built-in Polish dictionary +* [Lucene.Net.Analysis.Morfologik](xref:Lucene.Net.Analysis.Morfologik) - Analyzer for dictionary stemming, built-in Polish dictionary * [Lucene.Net.Analysis.OpenNLP](xref:Lucene.Net.Analysis.OpenNlp) - OpenNLP Library Integration * [Lucene.Net.Analysis.Phonetic](xref:Lucene.Net.Analysis.Phonetic) - Analyzer for indexing phonetic signatures (for sounds-alike search) * [Lucene.Net.Analysis.SmartCn](xref:Lucene.Net.Analysis.Cn.Smart) - Analyzer for indexing Chinese @@ -52,19 +52,19 @@ on some of the conceptual or inner details of Lucene: * [Lucene.Net.Codecs](xref:Lucene.Net.Codecs) - Lucene codecs and postings formats * [Lucene.Net.Expressions](xref:Lucene.Net.Expressions) - Dynamically computed values to sort/facet/search on based on a pluggable grammar * [Lucene.Net.Facet](xref:Lucene.Net.Facet) - Faceted indexing and search capabilities -* [Lucene.Net.Grouping](xref:Lucene.Net.Search.Grouping) - Collectors for grouping search results +* [Lucene.Net.Grouping](xref:Lucene.Net.Grouping) - Collectors for grouping search results * [Lucene.Net.Highlighter](xref:Lucene.Net.Search.Highlight) - Highlights search keywords in results * [Lucene.Net.ICU](xref:Lucene.Net.Analysis.Icu) - Specialized ICU (International Components for Unicode) Analyzers and Highlighters * [Lucene.Net.Join](xref:Lucene.Net.Join) - Index-time and Query-time joins for normalized content * [Lucene.Net.Memory](xref:Lucene.Net.Index.Memory) - Single-document in-memory index implementation * [Lucene.Net.Misc](xref:Lucene.Net.Misc) - Index tools and other miscellaneous code * [Lucene.Net.Queries](xref:Lucene.Net.Queries) - Filters and Queries that add to core Lucene -* [Lucene.Net.QueryParser](xref:Lucene.Net.QueryParsers.Classic) - Text to Query parsers and parsing framework +* [Lucene.Net.QueryParser](xref:Lucene.Net.QueryParser) - Text to Query parsers and parsing framework * [Lucene.Net.Replicator](xref:Lucene.Net.Replicator) Files replication utility * [Lucene.Net.Sandbox](xref:Lucene.Net.Sandbox) - Various third party contributions and new ideas * [Lucene.Net.Spatial](xref:Lucene.Net.Spatial) - Geospatial search -* [Lucene.Net.Suggest](xref:Lucene.Net.Search.Suggest) - Auto-suggest and Spell-checking support -* [Lucene.Net.TestFramework](xref:Lucene.Net.Testframework) - Framework for testing Lucene-based applications +* [Lucene.Net.Suggest](xref:Lucene.Net.Suggest) - Auto-suggest and Spell-checking support +* [Lucene.Net.TestFramework](xref:Lucene.Net.TestFramework) - Framework for testing Lucene-based applications ### Tools