Lucene.Net.Misc: fix documentation comment formatting problems
Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/b163f89d Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/b163f89d Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/b163f89d Branch: refs/heads/api-work Commit: b163f89de6d347028ba114134769bd6d44b7bfe8 Parents: 66d768a Author: Shad Storhaug <[email protected]> Authored: Sun Feb 5 12:42:47 2017 +0700 Committer: Shad Storhaug <[email protected]> Committed: Sun Feb 5 14:47:51 2017 +0700 ---------------------------------------------------------------------- src/Lucene.Net.Misc/Index/CompoundFileExtractor.cs | 14 ++++++-------- src/Lucene.Net.Misc/Index/MultiPassIndexSplitter.cs | 1 + .../Index/Sorter/EarlyTerminatingSortingCollector.cs | 2 +- src/Lucene.Net.Misc/Index/Sorter/Sorter.cs | 2 +- src/Lucene.Net.Misc/Misc/HighFreqTerms.cs | 2 +- src/Lucene.Net.Misc/Util/Fst/ListOfOutputs.cs | 6 +++--- .../Util/Fst/UpToTwoPositiveIntOutputs.cs | 2 +- 7 files changed, 14 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b163f89d/src/Lucene.Net.Misc/Index/CompoundFileExtractor.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Misc/Index/CompoundFileExtractor.cs b/src/Lucene.Net.Misc/Index/CompoundFileExtractor.cs index 2d2ee01..80ced50 100644 --- a/src/Lucene.Net.Misc/Index/CompoundFileExtractor.cs +++ b/src/Lucene.Net.Misc/Index/CompoundFileExtractor.cs @@ -23,18 +23,16 @@ namespace Lucene.Net.Index */ /// <summary> - /// Prints the filename and size of each file within a given compound file. - /// Add the -extract flag to extract files to the current working directory. - /// In order to make the extracted version of the index work, you have to copy - /// the segments file from the compound index into the directory where the extracted files are stored. </summary> - /// <param name="args"> Usage: org.apache.lucene.index.IndexReader [-extract] <cfsfile> </param> - - /// <summary> /// Command-line tool for extracting sub-files out of a compound file. /// </summary> public class CompoundFileExtractor { - + /// <summary> + /// Prints the filename and size of each file within a given compound file. + /// Add the -extract flag to extract files to the current working directory. + /// In order to make the extracted version of the index work, you have to copy + /// the segments file from the compound index into the directory where the extracted files are stored. </summary> + /// <param name="args"> Usage: org.apache.lucene.index.IndexReader [-extract] <cfsfile> </param> public static void Main(string[] args) { string filename = null; http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b163f89d/src/Lucene.Net.Misc/Index/MultiPassIndexSplitter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Misc/Index/MultiPassIndexSplitter.cs b/src/Lucene.Net.Misc/Index/MultiPassIndexSplitter.cs index 28c54c7..a8dff93 100644 --- a/src/Lucene.Net.Misc/Index/MultiPassIndexSplitter.cs +++ b/src/Lucene.Net.Misc/Index/MultiPassIndexSplitter.cs @@ -49,6 +49,7 @@ namespace Lucene.Net.Index /// <summary> /// Split source index into multiple parts. </summary> + /// <param name="version">lucene compatibility version</param> /// <param name="in"> source index, can have deletions, can have /// multiple segments (or multiple readers). </param> /// <param name="outputs"> list of directories where the output parts will be stored. </param> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b163f89d/src/Lucene.Net.Misc/Index/Sorter/EarlyTerminatingSortingCollector.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Misc/Index/Sorter/EarlyTerminatingSortingCollector.cs b/src/Lucene.Net.Misc/Index/Sorter/EarlyTerminatingSortingCollector.cs index 2a5a6d9..0c72c35 100644 --- a/src/Lucene.Net.Misc/Index/Sorter/EarlyTerminatingSortingCollector.cs +++ b/src/Lucene.Net.Misc/Index/Sorter/EarlyTerminatingSortingCollector.cs @@ -34,7 +34,7 @@ namespace Lucene.Net.Index.Sorter /// </para> /// <para> /// <b>NOTE</b>: If you wrap a <see cref="Search.TopDocsCollector{T}"/> that sorts in the same - /// order as the index order, the returned <see cref="TopDocsCollector{T}.TopDocs">TopDocs</see> + /// order as the index order, the returned <see cref="TopDocsCollector{T}.GetTopDocs()">TopDocs</see> /// will be correct. However the total of <see cref="TopDocsCollector{T}.TotalHits"/> /// hit count will be underestimated since not all matching documents will have /// been collected. http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b163f89d/src/Lucene.Net.Misc/Index/Sorter/Sorter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Misc/Index/Sorter/Sorter.cs b/src/Lucene.Net.Misc/Index/Sorter/Sorter.cs index b176574..f0be656 100644 --- a/src/Lucene.Net.Misc/Index/Sorter/Sorter.cs +++ b/src/Lucene.Net.Misc/Index/Sorter/Sorter.cs @@ -317,7 +317,7 @@ namespace Lucene.Net.Index.Sorter /// <para>This identifier is similar to <see cref="object.GetHashCode()"/> and should be /// chosen so that two instances of this class that sort documents likewise /// will have the same identifier. On the contrary, this identifier should be - /// different on different <see cref="Sort">sorts</see>. + /// different on different <see cref="Search.Sort">sorts</see>. /// </para> /// </summary> public string ID http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b163f89d/src/Lucene.Net.Misc/Misc/HighFreqTerms.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Misc/Misc/HighFreqTerms.cs b/src/Lucene.Net.Misc/Misc/HighFreqTerms.cs index 1f94deb..6675a52 100644 --- a/src/Lucene.Net.Misc/Misc/HighFreqTerms.cs +++ b/src/Lucene.Net.Misc/Misc/HighFreqTerms.cs @@ -92,7 +92,7 @@ namespace Lucene.Net.Misc } /// <summary> - /// Returns <see cref="TermStats[]"/> ordered by the specified comparer + /// Returns <see cref="T:TermStats[]"/> ordered by the specified comparer /// </summary> public static TermStats[] GetHighFreqTerms(IndexReader reader, int numTerms, string field, IComparer<TermStats> comparer) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b163f89d/src/Lucene.Net.Misc/Util/Fst/ListOfOutputs.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Misc/Util/Fst/ListOfOutputs.cs b/src/Lucene.Net.Misc/Util/Fst/ListOfOutputs.cs index 45f3d92..851f7cb 100644 --- a/src/Lucene.Net.Misc/Util/Fst/ListOfOutputs.cs +++ b/src/Lucene.Net.Misc/Util/Fst/ListOfOutputs.cs @@ -28,9 +28,9 @@ namespace Lucene.Net.Util.Fst /// more of its output values. You can use this when a single /// input may need to map to more than one output, /// maintaining order: pass the same input with a different - /// output by calling <see cref="Builder.Add(IntsRef,T)"/> multiple + /// output by calling <see cref="Builder{T}.Add(IntsRef,T)"/> multiple /// times. The builder will then combine the outputs using - /// the <see cref="Outputs.Merge(T,T)"/> method. + /// the <see cref="Outputs{T}.Merge(T,T)"/> method. /// /// <para>The resulting FST may not be minimal when an input has /// more than one output, as this requires pushing all @@ -40,7 +40,7 @@ namespace Lucene.Net.Util.Fst /// <para>NOTE: the only way to create multiple outputs is to /// add the same input to the FST multiple times in a row. This is /// how the FST maps a single input to multiple outputs (e.g. you - /// cannot pass a List<Object> to <see cref="Builder.Add(IntsRef, T)"/>). If + /// cannot pass a List<Object> to <see cref="Builder{T}.Add(IntsRef, T)"/>). If /// your outputs are longs, and you need at most 2, then use /// <see cref="UpToTwoPositiveIntOutputs"/> instead since it stores /// the outputs more compactly (by stealing a bit from each http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b163f89d/src/Lucene.Net.Misc/Util/Fst/UpToTwoPositiveIntOutputs.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Misc/Util/Fst/UpToTwoPositiveIntOutputs.cs b/src/Lucene.Net.Misc/Util/Fst/UpToTwoPositiveIntOutputs.cs index 8378f20..1e4cb0f 100644 --- a/src/Lucene.Net.Misc/Util/Fst/UpToTwoPositiveIntOutputs.cs +++ b/src/Lucene.Net.Misc/Util/Fst/UpToTwoPositiveIntOutputs.cs @@ -34,7 +34,7 @@ namespace Lucene.Net.Util.Fst /// <para>NOTE: the only way to create a TwoLongs output is to /// add the same input to the FST twice in a row. This is /// how the FST maps a single input to two outputs (e.g. you - /// cannot pass a <see cref="TwoLongs"/> to <see cref="Builder.Add(IntsRef, T)"/>. If you + /// cannot pass a <see cref="TwoLongs"/> to <see cref="Builder{T}.Add(IntsRef, T)"/>. If you /// need more than two then use <see cref="ListOfOutputs{T}"/>, but if /// you only have at most 2 then this implementation will /// require fewer bytes as it steals one bit from each long
