Lucene.Net.Codecs.Lucene46: Fixed XML documentation comment warnings
Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/5478f1bb Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/5478f1bb Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/5478f1bb Branch: refs/heads/master Commit: 5478f1bbeadbca0d48ff0a2e97723126438a5682 Parents: 8214105 Author: Shad Storhaug <[email protected]> Authored: Mon Jun 5 08:32:51 2017 +0700 Committer: Shad Storhaug <[email protected]> Committed: Tue Jun 6 06:58:40 2017 +0700 ---------------------------------------------------------------------- CONTRIBUTING.md | 3 +- src/Lucene.Net/Codecs/Lucene46/Lucene46Codec.cs | 22 ++-- .../Codecs/Lucene46/Lucene46FieldInfosFormat.cs | 112 +++++++++---------- .../Codecs/Lucene46/Lucene46FieldInfosReader.cs | 7 +- .../Codecs/Lucene46/Lucene46FieldInfosWriter.cs | 5 +- .../Lucene46/Lucene46SegmentInfoFormat.cs | 68 ++++++----- .../Lucene46/Lucene46SegmentInfoReader.cs | 7 +- .../Lucene46/Lucene46SegmentInfoWriter.cs | 7 +- 8 files changed, 116 insertions(+), 115 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5478f1bb/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21694de..0d350a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,8 +57,7 @@ helpers to help with that, see for examples see our [Java style methods to avoid 4. Codecs.Lucene41 (namespace) 5. Codecs.Lucene42 (namespace) 6. Codecs.Lucene45 (namespace) - 7. Codecs.Lucene46 (namespace) - 8. Util.Packed (namespace) + 7. Util.Packed (namespace) 2. Lucene.Net.Codecs (project) 1. Appending (namespace) 2. BlockTerms (namespace) http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5478f1bb/src/Lucene.Net/Codecs/Lucene46/Lucene46Codec.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene46/Lucene46Codec.cs b/src/Lucene.Net/Codecs/Lucene46/Lucene46Codec.cs index 960138f..d8f9e0e 100644 --- a/src/Lucene.Net/Codecs/Lucene46/Lucene46Codec.cs +++ b/src/Lucene.Net/Codecs/Lucene46/Lucene46Codec.cs @@ -27,12 +27,14 @@ namespace Lucene.Net.Codecs.Lucene46 /// <summary> /// Implements the Lucene 4.6 index format, with configurable per-field postings /// and docvalues formats. - /// <p> + /// <para/> /// If you want to reuse functionality of this codec in another codec, extend - /// <seealso cref="FilterCodec"/>. + /// <see cref="FilterCodec"/>. + /// <para/> + /// See <see cref="Lucene.Net.Codecs.Lucene46"/> package documentation for file format details. + /// <para/> + /// @lucene.experimental /// </summary> - /// <seealso cref= Lucene.Net.Codecs.Lucene46 package documentation for file format details. - /// @lucene.experimental </seealso> // NOTE: if we make largish changes in a minor release, easier to just make Lucene46Codec or whatever // if they are backwards compatible or smallish we can probably do the backwards in the postingsreader // (it writes a minor version, etc). @@ -120,9 +122,9 @@ namespace Lucene.Net.Codecs.Lucene46 /// <summary> /// Returns the postings format that should be used for writing - /// new segments of <code>field</code>. - /// - /// The default implementation always returns "Lucene41" + /// new segments of <paramref name="field"/>. + /// <para/> + /// The default implementation always returns "Lucene41" /// </summary> public virtual PostingsFormat GetPostingsFormatForField(string field) { @@ -131,9 +133,9 @@ namespace Lucene.Net.Codecs.Lucene46 /// <summary> /// Returns the docvalues format that should be used for writing - /// new segments of <code>field</code>. - /// - /// The default implementation always returns "Lucene45" + /// new segments of <paramref name="field"/>. + /// <para/> + /// The default implementation always returns "Lucene45" /// </summary> public virtual DocValuesFormat GetDocValuesFormatForField(string field) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5478f1bb/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosFormat.cs b/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosFormat.cs index 40c681c..4b1755a 100644 --- a/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosFormat.cs +++ b/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosFormat.cs @@ -19,65 +19,65 @@ namespace Lucene.Net.Codecs.Lucene46 /// <summary> /// Lucene 4.6 Field Infos format. - /// <p> - /// <p>Field names are stored in the field info file, with suffix <tt>.fnm</tt>.</p> - /// <p>FieldInfos (.fnm) --> Header,FieldsCount, <FieldName,FieldNumber, - /// FieldBits,DocValuesBits,DocValuesGen,Attributes> <sup>FieldsCount</sup>,Footer</p> - /// <p>Data types: - /// <ul> - /// <li>Header --> <seealso cref="CodecUtil#checkHeader CodecHeader"/></li> - /// <li>FieldsCount --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>FieldName --> <seealso cref="DataOutput#writeString String"/></li> - /// <li>FieldBits, DocValuesBits --> <seealso cref="DataOutput#writeByte Byte"/></li> - /// <li>FieldNumber --> <seealso cref="DataOutput#writeInt VInt"/></li> - /// <li>Attributes --> <seealso cref="DataOutput#writeStringStringMap Map<String,String>"/></li> - /// <li>DocValuesGen --> <seealso cref="DataOutput#writeLong(long) Int64"/></li> - /// <li>Footer --> <seealso cref="CodecUtil#writeFooter CodecFooter"/></li> - /// </ul> - /// </p> + /// <para/> + /// <para>Field names are stored in the field info file, with suffix <c>.fnm</c>.</para> + /// <para>FieldInfos (.fnm) --> Header,FieldsCount, <FieldName,FieldNumber, + /// FieldBits,DocValuesBits,DocValuesGen,Attributes> <sup>FieldsCount</sup>,Footer</para> + /// <para>Data types: + /// <list type="bullet"> + /// <item><description>Header --> CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>)</description></item> + /// <item><description>FieldsCount --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>)</description></item> + /// <item><description>FieldName --> String (<see cref="Store.DataOutput.WriteString(string)"/>)</description></item> + /// <item><description>FieldBits, DocValuesBits --> Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>)</description></item> + /// <item><description>FieldNumber --> VInt (<see cref="Store.DataOutput.WriteInt32(int)"/>)</description></item> + /// <item><description>Attributes --> IDictionary<String,String> (<see cref="Store.DataOutput.WriteStringStringMap(System.Collections.Generic.IDictionary{string, string})"/>)</description></item> + /// <item><description>DocValuesGen --> Int64 (<see cref="Store.DataOutput.WriteInt64(long)"/>)</description></item> + /// <item><description>Footer --> CodecFooter (<see cref="CodecUtil.WriteFooter(Store.IndexOutput)"/>)</description></item> + /// </list> + /// </para> /// Field Descriptions: - /// <ul> - /// <li>FieldsCount: the number of fields in this file.</li> - /// <li>FieldName: name of the field as a UTF-8 String.</li> - /// <li>FieldNumber: the field's number. Note that unlike previous versions of + /// <list type="bullet"> + /// <item><description>FieldsCount: the number of fields in this file.</description></item> + /// <item><description>FieldName: name of the field as a UTF-8 string.</description></item> + /// <item><description>FieldNumber: the field's number. Note that unlike previous versions of /// Lucene, the fields are not numbered implicitly by their order in the - /// file, instead explicitly.</li> - /// <li>FieldBits: a byte containing field options. - /// <ul> - /// <li>The low-order bit is one for indexed fields, and zero for non-indexed - /// fields.</li> - /// <li>The second lowest-order bit is one for fields that have term vectors - /// stored, and zero for fields without term vectors.</li> - /// <li>If the third lowest order-bit is set (0x4), offsets are stored into - /// the postings list in addition to positions.</li> - /// <li>Fourth bit is unused.</li> - /// <li>If the fifth lowest-order bit is set (0x10), norms are omitted for the - /// indexed field.</li> - /// <li>If the sixth lowest-order bit is set (0x20), payloads are stored for the - /// indexed field.</li> - /// <li>If the seventh lowest-order bit is set (0x40), term frequencies and - /// positions omitted for the indexed field.</li> - /// <li>If the eighth lowest-order bit is set (0x80), positions are omitted for the - /// indexed field.</li> - /// </ul> - /// </li> - /// <li>DocValuesBits: a byte containing per-document value types. The type + /// file, instead explicitly.</description></item> + /// <item><description>FieldBits: a <see cref="byte"/> containing field options. + /// <list type="bullet"> + /// <item><description>The low-order bit is one for indexed fields, and zero for non-indexed + /// fields.</description></item> + /// <item><description>The second lowest-order bit is one for fields that have term vectors + /// stored, and zero for fields without term vectors.</description></item> + /// <item><description>If the third lowest order-bit is set (0x4), offsets are stored into + /// the postings list in addition to positions.</description></item> + /// <item><description>Fourth bit is unused.</description></item> + /// <item><description>If the fifth lowest-order bit is set (0x10), norms are omitted for the + /// indexed field.</description></item> + /// <item><description>If the sixth lowest-order bit is set (0x20), payloads are stored for the + /// indexed field.</description></item> + /// <item><description>If the seventh lowest-order bit is set (0x40), term frequencies and + /// positions omitted for the indexed field.</description></item> + /// <item><description>If the eighth lowest-order bit is set (0x80), positions are omitted for the + /// indexed field.</description></item> + /// </list> + /// </description></item> + /// <item><description>DocValuesBits: a <see cref="byte"/> containing per-document value types. The type /// recorded as two four-bit integers, with the high-order bits representing - /// <code>norms</code> options, and the low-order bits representing - /// {@code DocValues} options. Each four-bit integer can be decoded as such: - /// <ul> - /// <li>0: no DocValues for this field.</li> - /// <li>1: NumericDocValues. (<seealso cref="DocValuesType#NUMERIC"/>)</li> - /// <li>2: BinaryDocValues. ({@code DocValuesType#BINARY})</li> - /// <li>3: SortedDocValues. ({@code DocValuesType#SORTED})</li> - /// </ul> - /// </li> - /// <li>DocValuesGen is the generation count of the field's DocValues. If this is -1, - /// there are no DocValues updates to that field. Anything above zero means there - /// are updates stored by <seealso cref="DocValuesFormat"/>.</li> - /// <li>Attributes: a key-value map of codec-private attributes.</li> - /// </ul> - /// + /// <c>norms</c> options, and the low-order bits representing + /// <see cref="Index.DocValues"/> options. Each four-bit integer can be decoded as such: + /// <list type="bullet"> + /// <item><description>0: no DocValues for this field.</description></item> + /// <item><description>1: <see cref="Index.NumericDocValues"/>. (<see cref="Index.DocValuesType.NUMERIC"/>)</description></item> + /// <item><description>2: <see cref="Index.BinaryDocValues"/>. (<see cref="Index.DocValuesType.BINARY"/>)</description></item> + /// <item><description>3: <see cref="Index.SortedDocValues"/>. (<see cref="Index.DocValuesType.SORTED"/>)</description></item> + /// </list> + /// </description></item> + /// <item><description>DocValuesGen is the generation count of the field's <see cref="Index.DocValues"/>. If this is -1, + /// there are no <see cref="Index.DocValues"/> updates to that field. Anything above zero means there + /// are updates stored by <see cref="DocValuesFormat"/>.</description></item> + /// <item><description>Attributes: a key-value map of codec-private attributes.</description></item> + /// </list> + /// <para/> /// @lucene.experimental /// </summary> public sealed class Lucene46FieldInfosFormat : FieldInfosFormat http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5478f1bb/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosReader.cs b/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosReader.cs index 0a3bacc..e46df2d 100644 --- a/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosReader.cs +++ b/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosReader.cs @@ -34,9 +34,10 @@ namespace Lucene.Net.Codecs.Lucene46 /// <summary> /// Lucene 4.6 FieldInfos reader. - /// - /// @lucene.experimental </summary> - /// <seealso cref= Lucene46FieldInfosFormat </seealso> + /// <para/> + /// @lucene.experimental + /// </summary> + /// <seealso cref="Lucene46FieldInfosFormat"/> internal sealed class Lucene46FieldInfosReader : FieldInfosReader { /// <summary> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5478f1bb/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosWriter.cs b/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosWriter.cs index a2fcf85..eafa70d 100644 --- a/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosWriter.cs +++ b/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosWriter.cs @@ -32,9 +32,10 @@ namespace Lucene.Net.Codecs.Lucene46 /// <summary> /// Lucene 4.6 FieldInfos writer. + /// <para/> + /// @lucene.experimental /// </summary> - /// <seealso cref= Lucene46FieldInfosFormat - /// @lucene.experimental </seealso> + /// <seealso cref="Lucene46FieldInfosFormat"/> internal sealed class Lucene46FieldInfosWriter : FieldInfosWriter { /// <summary> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5478f1bb/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoFormat.cs b/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoFormat.cs index f50fecc..65d3e88 100644 --- a/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoFormat.cs +++ b/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoFormat.cs @@ -17,50 +17,46 @@ namespace Lucene.Net.Codecs.Lucene46 * limitations under the License. */ - // javadocs - using SegmentInfo = Lucene.Net.Index.SegmentInfo; // javadocs - - // javadocs - // javadocs + using SegmentInfo = Lucene.Net.Index.SegmentInfo; /// <summary> /// Lucene 4.6 Segment info format. - /// <p> + /// <para> /// Files: - /// <ul> - /// <li><tt>.si</tt>: Header, SegVersion, SegSize, IsCompoundFile, Diagnostics, Files, Footer - /// </ul> - /// </p> + /// <list type="bullet"> + /// <item><description><c>.si</c>: Header, SegVersion, SegSize, IsCompoundFile, Diagnostics, Files, Footer</description></item> + /// </list> + /// </para> /// Data types: - /// <p> - /// <ul> - /// <li>Header --> <seealso cref="CodecUtil#writeHeader CodecHeader"/></li> - /// <li>SegSize --> <seealso cref="DataOutput#writeInt Int32"/></li> - /// <li>SegVersion --> <seealso cref="DataOutput#writeString String"/></li> - /// <li>Files --> <seealso cref="DataOutput#writeStringSet Set<String>"/></li> - /// <li>Diagnostics --> <seealso cref="DataOutput#writeStringStringMap Map<String,String>"/></li> - /// <li>IsCompoundFile --> <seealso cref="DataOutput#writeByte Int8"/></li> - /// <li>Footer --> <seealso cref="CodecUtil#writeFooter CodecFooter"/></li> - /// </ul> - /// </p> + /// <para> + /// <list type="bullet"> + /// <item><description>Header --> CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item> + /// <item><description>SegSize --> Int32 (<see cref="Store.DataOutput.WriteInt32(int)"/>) </description></item> + /// <item><description>SegVersion --> String (<see cref="Store.DataOutput.WriteString(string)"/>) </description></item> + /// <item><description>Files --> ISet<String> (<see cref="Store.DataOutput.WriteStringSet(System.Collections.Generic.ISet{string})"/>) </description></item> + /// <item><description>Diagnostics --> IDictionary<String,String> (<see cref="Store.DataOutput.WriteStringStringMap(System.Collections.Generic.IDictionary{string, string})"/>) </description></item> + /// <item><description>IsCompoundFile --> Int8 (<see cref="Store.DataOutput.WriteByte(byte)"/>) </description></item> + /// <item><description>Footer --> CodecFooter (<see cref="CodecUtil.WriteFooter(Store.IndexOutput)"/>) </description></item> + /// </list> + /// </para> /// Field Descriptions: - /// <p> - /// <ul> - /// <li>SegVersion is the code version that created the segment.</li> - /// <li>SegSize is the number of documents contained in the segment index.</li> - /// <li>IsCompoundFile records whether the segment is written as a compound file or + /// <para> + /// <list type="bullet"> + /// <item><description>SegVersion is the code version that created the segment.</description></item> + /// <item><description>SegSize is the number of documents contained in the segment index.</description></item> + /// <item><description>IsCompoundFile records whether the segment is written as a compound file or /// not. If this is -1, the segment is not a compound file. If it is 1, the segment - /// is a compound file.</li> - /// <li>The Diagnostics Map is privately written by <seealso cref="IndexWriter"/>, as a debugging aid, + /// is a compound file.</description></item> + /// <item><description>The Diagnostics Map is privately written by <see cref="Index.IndexWriter"/>, as a debugging aid, /// for each segment it creates. It includes metadata like the current Lucene - /// version, OS, Java version, why the segment was created (merge, flush, - /// addIndexes), etc.</li> - /// <li>Files is a list of files referred to by this segment.</li> - /// </ul> - /// </p> + /// version, OS, .NET/Java version, why the segment was created (merge, flush, + /// addIndexes), etc.</description></item> + /// <item><description>Files is a list of files referred to by this segment.</description></item> + /// </list> + /// </para> + /// @lucene.experimental /// </summary> - /// <seealso cref= SegmentInfos - /// @lucene.experimental </seealso> + /// <seealso cref="Index.SegmentInfos"/> public class Lucene46SegmentInfoFormat : SegmentInfoFormat { private readonly SegmentInfoReader reader = new Lucene46SegmentInfoReader(); @@ -89,7 +85,7 @@ namespace Lucene.Net.Codecs.Lucene46 } /// <summary> - /// File extension used to store <seealso cref="SegmentInfo"/>. </summary> + /// File extension used to store <see cref="SegmentInfo"/>. </summary> public readonly static string SI_EXTENSION = "si"; internal const string CODEC_NAME = "Lucene46SegmentInfo"; http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5478f1bb/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoReader.cs b/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoReader.cs index 6cb374e..19a856a 100644 --- a/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoReader.cs +++ b/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoReader.cs @@ -28,10 +28,11 @@ namespace Lucene.Net.Codecs.Lucene46 using SegmentInfo = Lucene.Net.Index.SegmentInfo; /// <summary> - /// Lucene 4.6 implementation of <seealso cref="SegmentInfoReader"/>. + /// Lucene 4.6 implementation of <see cref="SegmentInfoReader"/>. + /// <para/> + /// @lucene.experimental /// </summary> - /// <seealso cref= Lucene46SegmentInfoFormat - /// @lucene.experimental </seealso> + /// <seealso cref="Lucene46SegmentInfoFormat"/> public class Lucene46SegmentInfoReader : SegmentInfoReader { /// <summary> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5478f1bb/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoWriter.cs b/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoWriter.cs index 9cf8da9..a39be6d 100644 --- a/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoWriter.cs +++ b/src/Lucene.Net/Codecs/Lucene46/Lucene46SegmentInfoWriter.cs @@ -26,10 +26,11 @@ namespace Lucene.Net.Codecs.Lucene46 using SegmentInfo = Lucene.Net.Index.SegmentInfo; /// <summary> - /// Lucene 4.0 implementation of <seealso cref="SegmentInfoWriter"/>. + /// Lucene 4.0 implementation of <see cref="SegmentInfoWriter"/>. + /// <para/> + /// @lucene.experimental /// </summary> - /// <seealso cref= Lucene46SegmentInfoFormat - /// @lucene.experimental </seealso> + /// <seealso cref="Lucene46SegmentInfoFormat"/> public class Lucene46SegmentInfoWriter : SegmentInfoWriter { /// <summary>
