http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Memory/FSTPulsing41PostingsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Memory/FSTPulsing41PostingsFormat.cs b/src/Lucene.Net.Codecs/Memory/FSTPulsing41PostingsFormat.cs index 14d3de9..839588a 100644 --- a/src/Lucene.Net.Codecs/Memory/FSTPulsing41PostingsFormat.cs +++ b/src/Lucene.Net.Codecs/Memory/FSTPulsing41PostingsFormat.cs @@ -26,8 +26,9 @@ /// <summary> /// FST + Pulsing41, test only, since - /// FST does no delta encoding here! - /// @lucene.experimental + /// FST does no delta encoding here! + /// <para/> + /// @lucene.experimental /// </summary> [PostingsFormatName("FSTPulsing41")] // LUCENENET specific - using PostingsFormatName attribute to ensure the default name passed from subclasses is the same as this class name public class FSTPulsing41PostingsFormat : PostingsFormat
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Memory/FSTTermOutputs.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Memory/FSTTermOutputs.cs b/src/Lucene.Net.Codecs/Memory/FSTTermOutputs.cs index 040b999..82d39ac 100644 --- a/src/Lucene.Net.Codecs/Memory/FSTTermOutputs.cs +++ b/src/Lucene.Net.Codecs/Memory/FSTTermOutputs.cs @@ -28,8 +28,8 @@ namespace Lucene.Net.Codecs.Memory /// <summary> /// An FST implementation for - /// <seealso cref="FSTTermsWriter"/>. - /// + /// <see cref="FSTTermsWriter"/>. + /// <para/> /// @lucene.experimental /// </summary> @@ -117,13 +117,12 @@ namespace Lucene.Net.Codecs.Memory /// <summary> /// The return value will be the smaller one, when these two are - /// 'comparable', i.e. - /// 1. every value in t1 is not larger than in t2, or - /// 2. every value in t1 is not smaller than t2. + /// 'comparable', i.e. + /// <list type="number"> + /// <item><description>every value in t1 is not larger than in t2, or</description></item> + /// <item><description>every value in t1 is not smaller than t2.</description></item> + /// </list> /// </summary> - /// <param name="t1"></param> - /// <param name="t2"></param> - /// <returns></returns> public override TermData Common(TermData t1, TermData t2) { if (Equals(t1, NO_OUTPUT) || Equals(t2, NO_OUTPUT)) @@ -371,7 +370,7 @@ namespace Lucene.Net.Codecs.Memory } /// <summary> - /// NOTE: This was longsEqual() in Lucene + /// NOTE: This was longsEqual() in Lucene. /// </summary> private static bool Int64sEqual(TermData t1, TermData t2) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Memory/FSTTermsReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Memory/FSTTermsReader.cs b/src/Lucene.Net.Codecs/Memory/FSTTermsReader.cs index 5141776..6a19546 100644 --- a/src/Lucene.Net.Codecs/Memory/FSTTermsReader.cs +++ b/src/Lucene.Net.Codecs/Memory/FSTTermsReader.cs @@ -50,10 +50,10 @@ namespace Lucene.Net.Codecs.Memory /// <summary> /// FST-based terms dictionary reader. - /// + /// <para/> /// The FST directly maps each term and its metadata, /// it is memory resident. - /// + /// <para/> /// @lucene.experimental /// </summary> public class FSTTermsReader : FieldsProducer @@ -287,18 +287,18 @@ namespace Lucene.Net.Codecs.Memory { private readonly FSTTermsReader.TermsReader outerInstance; - /// <summary>Current term, null when enum ends or unpositioned</summary> + /// <summary>Current term, null when enum ends or unpositioned.</summary> internal BytesRef term_Renamed; - /// <summary>Current term stats + decoded metadata (customized by PBF)</summary> + /// <summary>Current term stats + decoded metadata (customized by PBF).</summary> internal readonly BlockTermState state; - /// <summary>Current term stats + undecoded metadata (long[] & byte[])</summary> + /// <summary>Current term stats + undecoded metadata (long[] & byte[]).</summary> internal FSTTermOutputs.TermData meta; internal ByteArrayDataInput bytesReader; /// <summary> - /// Decodes metadata into customized term state </summary> + /// Decodes metadata into customized term state. </summary> internal abstract void DecodeMetaData(); internal BaseTermsEnum(FSTTermsReader.TermsReader outerInstance) @@ -366,10 +366,10 @@ namespace Lucene.Net.Codecs.Memory private readonly BytesRefFSTEnum<FSTTermOutputs.TermData> fstEnum; - /// <summary>True when current term's metadata is decoded</summary> + /// <summary>True when current term's metadata is decoded.</summary> private bool decoded; - /// <summary>True when current enum is 'positioned' by seekExact(TermState)</summary> + /// <summary>True when current enum is 'positioned' by <see cref="SeekExact(BytesRef, TermState)"/>.</summary> private bool seekPending; internal SegmentTermsEnum(FSTTermsReader.TermsReader outerInstance) @@ -469,43 +469,43 @@ namespace Lucene.Net.Codecs.Memory { private readonly FSTTermsReader.TermsReader outerInstance; - /// <summary>True when current term's metadata is decoded</summary> + /// <summary>True when current term's metadata is decoded.</summary> private bool decoded; - /// <summary>True when there is pending term when calling Next()</summary> + /// <summary>True when there is pending term when calling <see cref="Next()"/>.</summary> private bool pending; /// <summary> /// stack to record how current term is constructed, /// used to accumulate metadata or rewind term: /// level == term.Length + 1, - /// == 0 when term is null */ + /// == 0 when term is null /// </summary> private Frame[] stack; private int level; /// <summary> - /// to which level the metadata is accumulated - /// so that we can accumulate metadata lazily + /// To which level the metadata is accumulated + /// so that we can accumulate metadata lazily. /// </summary> private int metaUpto; - /// <summary>term dict fst</summary> + /// <summary>Term dict fst.</summary> private readonly FST<FSTTermOutputs.TermData> fst; private readonly FST.BytesReader fstReader; private readonly Outputs<FSTTermOutputs.TermData> fstOutputs; - /// <summary>query automaton to intersect with</summary> + /// <summary>Query automaton to intersect with.</summary> private readonly ByteRunAutomaton fsa; internal sealed class Frame { private readonly FSTTermsReader.TermsReader.IntersectTermsEnum outerInstance; - /// <summary>fst stats</summary> + /// <summary>Fst stats.</summary> internal FST.Arc<FSTTermOutputs.TermData> fstArc; - /// <summary>automaton stats</summary> + /// <summary>Automaton stats.</summary> internal int fsaState; internal Frame(FSTTermsReader.TermsReader.IntersectTermsEnum outerInstance) @@ -581,7 +581,7 @@ namespace Lucene.Net.Codecs.Memory } /// <summary> - /// Lazily accumulate meta data, when we got a accepted term </summary> + /// Lazily accumulate meta data, when we got a accepted term. </summary> /// <exception cref="System.IO.IOException"/> internal void LoadMetaData() { @@ -708,7 +708,7 @@ namespace Lucene.Net.Codecs.Memory return null; } - /// <summary> Virtual frame, never pop </summary> + /// <summary> Virtual frame, never pop. </summary> private Frame LoadVirtualFrame(Frame frame) { frame.fstArc.Output = fstOutputs.NoOutput; @@ -717,7 +717,7 @@ namespace Lucene.Net.Codecs.Memory return frame; } - /// <summary> Load frame for start arc(node) on fst </summary> + /// <summary> Load frame for start arc(node) on fst. </summary> private Frame LoadFirstFrame(Frame frame) { frame.fstArc = fst.GetFirstArc(frame.fstArc); @@ -726,7 +726,7 @@ namespace Lucene.Net.Codecs.Memory } /// <summary> - /// Load frame for target arc(node) on fst </summary> + /// Load frame for target arc(node) on fst. </summary> private Frame LoadExpandFrame(Frame top, Frame frame) { if (!CanGrow(top)) @@ -743,7 +743,7 @@ namespace Lucene.Net.Codecs.Memory return frame; } - /// <summary> Load frame for sibling arc(node) on fst </summary> + /// <summary> Load frame for sibling arc(node) on fst. </summary> private Frame LoadNextFrame(Frame top, Frame frame) { if (!CanRewind(frame)) @@ -769,7 +769,7 @@ namespace Lucene.Net.Codecs.Memory /// <summary> /// Load frame for target arc(node) on fst, so that - /// arc.label >= label and !fsa.reject(arc.label) + /// arc.label >= label and !fsa.reject(arc.label) /// </summary> private Frame LoadCeilFrame(int label, Frame top, Frame frame) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Memory/FSTTermsWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Memory/FSTTermsWriter.cs b/src/Lucene.Net.Codecs/Memory/FSTTermsWriter.cs index 2f2b7d6..8077e37 100644 --- a/src/Lucene.Net.Codecs/Memory/FSTTermsWriter.cs +++ b/src/Lucene.Net.Codecs/Memory/FSTTermsWriter.cs @@ -36,19 +36,20 @@ namespace Lucene.Net.Codecs.Memory /// <summary> /// FST-based term dict, using metadata as FST output. - /// + /// <para/> /// The FST directly holds the mapping between <term, metadata>. - /// + /// <para/> /// Term metadata consists of three parts: - /// 1. term statistics: docFreq, totalTermFreq; - /// 2. monotonic long[], e.g. the pointer to the postings list for that term; - /// 3. generic byte[], e.g. other information need by postings reader. - /// + /// <list type="number"> + /// <item><description>term statistics: docFreq, totalTermFreq;</description></item> + /// <item><description>monotonic long[], e.g. the pointer to the postings list for that term;</description></item> + /// <item><description>generic byte[], e.g. other information need by postings reader.</description></item> + /// </list> /// <para> /// File: - /// <ul> - /// <li><tt>.tst</tt>: <a href="#Termdictionary">Term Dictionary</a></li> - /// </ul> + /// <list type="bullet"> + /// <item><description><c>.tst</c>: <a href="#Termdictionary">Term Dictionary</a></description></item> + /// </list> /// </para> /// <para> /// @@ -62,53 +63,53 @@ namespace Lucene.Net.Codecs.Memory /// to postings list). /// </para> /// <para> - /// Typically the metadata is separated into two parts: - /// <ul> - /// <li> + /// Typically the metadata is separated into two parts: + /// <list type="bullet"> + /// <item><description> /// Monotonical long array: Some metadata will always be ascending in order /// with the corresponding term. This part is used by FST to share outputs between arcs. - /// </li> - /// <li> + /// </description></item> + /// <item><description> /// Generic byte array: Used to store non-monotonic metadata. - /// </li> - /// </ul> + /// </description></item> + /// </list> /// </para> /// /// File format: - /// <ul> - /// <li>TermsDict(.tst) --> Header, <i>PostingsHeader</i>, FieldSummary, DirOffset</li> - /// <li>FieldSummary --> NumFields, <FieldNumber, NumTerms, SumTotalTermFreq?, - /// SumDocFreq, DocCount, LongsSize, TermFST ><sup>NumFields</sup></li> - /// <li>TermFST TermData - /// <li>TermData --> Flag, BytesSize?, LongDelta<sup>LongsSize</sup>?, Byte<sup>BytesSize</sup>?, - /// < DocFreq[Same?], (TotalTermFreq-DocFreq) > ? </li> - /// <li>Header --> <seealso cref="CodecUtil#writeHeader CodecHeader"/></li> - /// <li>DirOffset --> <seealso cref="DataOutput#writeLong Uint64"/></li> - /// <li>DocFreq, LongsSize, BytesSize, NumFields, - /// FieldNumber, DocCount --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>TotalTermFreq, NumTerms, SumTotalTermFreq, SumDocFreq, LongDelta --> - /// <seealso cref="DataOutput#writeVLong VLong"/></li> - /// </ul> + /// <list type="bullet"> + /// <item><description>TermsDict(.tst) --> Header, <i>PostingsHeader</i>, FieldSummary, DirOffset</description></item> + /// <item><description>FieldSummary --> NumFields, <FieldNumber, NumTerms, SumTotalTermFreq?, + /// SumDocFreq, DocCount, LongsSize, TermFST ><sup>NumFields</sup></description></item> + /// <item><description>TermFST TermData</description></item> + /// <item><description>TermData --> Flag, BytesSize?, LongDelta<sup>LongsSize</sup>?, Byte<sup>BytesSize</sup>?, + /// < DocFreq[Same?], (TotalTermFreq-DocFreq) > ? </description></item> + /// <item><description>Header --> CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item> + /// <item><description>DirOffset --> Uint64 (<see cref="Store.DataOutput.WriteInt64(long)"/>) </description></item> + /// <item><description>DocFreq, LongsSize, BytesSize, NumFields, + /// FieldNumber, DocCount --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// <item><description>TotalTermFreq, NumTerms, SumTotalTermFreq, SumDocFreq, LongDelta --> + /// VLong (<see cref="Store.DataOutput.WriteVInt64(long)"/>) </description></item> + /// </list> /// <para>Notes:</para> - /// <ul> - /// <li> + /// <list type="bullet"> + /// <item><description> /// The format of PostingsHeader and generic meta bytes are customized by the specific postings implementation: /// they contain arbitrary per-file data (such as parameters or versioning information), and per-term data /// (non-monotonic ones like pulsed postings data). - /// </li> - /// <li> + /// </description></item> + /// <item><description> /// The format of TermData is determined by FST, typically monotonic metadata will be dense around shallow arcs, /// while in deeper arcs only generic bytes and term statistics exist. - /// </li> - /// <li> + /// </description></item> + /// <item><description> /// The byte Flag is used to indicate which part of metadata exists on current arc. Specially the monotonic part /// is omitted when it is an array of 0s. - /// </li> - /// <li> + /// </description></item> + /// <item><description> /// Since LongsSize is per-field fixed, it is only written once in field summary. - /// </li> - /// </ul> - /// + /// </description></item> + /// </list> + /// <para/> /// @lucene.experimental /// </summary> public class FSTTermsWriter : FieldsConsumer @@ -213,7 +214,7 @@ namespace Lucene.Net.Codecs.Memory public long SumDocFreq { get; private set; } public int DocCount { get; private set; } /// <summary> - /// NOTE: This was longsSize (field) in Lucene + /// NOTE: This was longsSize (field) in Lucene. /// </summary> public int Int64sSize { get; private set; } public FST<FSTTermOutputs.TermData> Dict { get; private set; } http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Memory/MemoryDocValuesConsumer.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Memory/MemoryDocValuesConsumer.cs b/src/Lucene.Net.Codecs/Memory/MemoryDocValuesConsumer.cs index 0a798cb..4aef40c 100644 --- a/src/Lucene.Net.Codecs/Memory/MemoryDocValuesConsumer.cs +++ b/src/Lucene.Net.Codecs/Memory/MemoryDocValuesConsumer.cs @@ -43,7 +43,7 @@ namespace Lucene.Net.Codecs.Memory using Util = Util.Fst.Util; /// <summary> - /// Writer for <seealso cref="MemoryDocValuesFormat"/> + /// Writer for <see cref="MemoryDocValuesFormat"/>. /// </summary> internal class MemoryDocValuesConsumer : DocValuesConsumer { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Memory/MemoryDocValuesFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Memory/MemoryDocValuesFormat.cs b/src/Lucene.Net.Codecs/Memory/MemoryDocValuesFormat.cs index 3dad21c..4df853c 100644 --- a/src/Lucene.Net.Codecs/Memory/MemoryDocValuesFormat.cs +++ b/src/Lucene.Net.Codecs/Memory/MemoryDocValuesFormat.cs @@ -21,7 +21,7 @@ namespace Lucene.Net.Codecs.Memory */ /// <summary> - /// In-memory docvalues format </summary> + /// In-memory docvalues format. </summary> [DocValuesFormatName("Memory")] // LUCENENET specific - using DocValuesFormatName attribute to ensure the default name passed from subclasses is the same as this class name public class MemoryDocValuesFormat : DocValuesFormat { @@ -31,8 +31,8 @@ namespace Lucene.Net.Codecs.Memory internal readonly float acceptableOverheadRatio; /// <summary> - /// Calls {@link #MemoryDocValuesFormat(float) - /// MemoryDocValuesFormat(PackedInts.DEFAULT)} + /// Calls <c>MemoryDocValuesFormat(PackedInts.DEFAULT)</c> + /// (<see cref="MemoryDocValuesFormat(float)"/>) /// </summary> public MemoryDocValuesFormat() : this(PackedInt32s.DEFAULT) @@ -40,12 +40,13 @@ namespace Lucene.Net.Codecs.Memory } /// <summary> - /// Creates a new MemoryDocValuesFormat with the specified - /// <code>acceptableOverheadRatio</code> for NumericDocValues. </summary> - /// <param name="acceptableOverheadRatio"> compression parameter for numerics. - /// Currently this is only used when the number of unique values is small. - /// - /// @lucene.experimental </param> + /// Creates a new <see cref="MemoryDocValuesFormat"/> with the specified + /// <paramref name="acceptableOverheadRatio"/> for <see cref="NumericDocValues"/>. + /// <para/> + /// @lucene.experimental + /// </summary> + /// <param name="acceptableOverheadRatio"> Compression parameter for numerics. + /// Currently this is only used when the number of unique values is small. </param> public MemoryDocValuesFormat(float acceptableOverheadRatio) : base() { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Memory/MemoryDocValuesProducer.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Memory/MemoryDocValuesProducer.cs b/src/Lucene.Net.Codecs/Memory/MemoryDocValuesProducer.cs index b26bf2b..9e32c5a 100644 --- a/src/Lucene.Net.Codecs/Memory/MemoryDocValuesProducer.cs +++ b/src/Lucene.Net.Codecs/Memory/MemoryDocValuesProducer.cs @@ -31,7 +31,7 @@ namespace Lucene.Net.Codecs.Memory using Util = Lucene.Net.Util.Fst.Util; /// <summary> - /// TextReader for <seealso cref="MemoryDocValuesFormat"/> + /// TextReader for <see cref="MemoryDocValuesFormat"/>. /// </summary> internal class MemoryDocValuesProducer : DocValuesProducer { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Memory/MemoryPostingsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Memory/MemoryPostingsFormat.cs b/src/Lucene.Net.Codecs/Memory/MemoryPostingsFormat.cs index 9336c7b..eba1941 100644 --- a/src/Lucene.Net.Codecs/Memory/MemoryPostingsFormat.cs +++ b/src/Lucene.Net.Codecs/Memory/MemoryPostingsFormat.cs @@ -57,16 +57,15 @@ namespace Lucene.Net.Codecs.Memory // to disk. /// <summary> - /// Stores terms & postings (docs, positions, payloads) in - /// RAM, using an FST. + /// Stores terms & postings (docs, positions, payloads) in + /// RAM, using an FST. /// /// <para>Note that this codec implements advance as a linear /// scan! This means if you store large fields in here, /// queries that rely on advance will (AND BooleanQuery, /// PhraseQuery) will be relatively slow! - /// - /// @lucene.experimental /// </para> + /// @lucene.experimental /// </summary> // TODO: Maybe name this 'Cached' or something to reflect @@ -84,10 +83,10 @@ namespace Lucene.Net.Codecs.Memory } /// <summary> - /// Create MemoryPostingsFormat, specifying advanced FST options. </summary> - /// <param name="doPackFST"> true if a packed FST should be built. + /// Create <see cref="MemoryPostingsFormat"/>, specifying advanced FST options. </summary> + /// <param name="doPackFST"> <c>true</c> if a packed FST should be built. /// NOTE: packed FSTs are limited to ~2.1 GB of postings. </param> - /// <param name="acceptableOverheadRatio"> allowable overhead for packed ints + /// <param name="acceptableOverheadRatio"> Allowable overhead for packed <see cref="int"/>s /// during FST construction. </param> public MemoryPostingsFormat(bool doPackFST, float acceptableOverheadRatio) : base() http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Pulsing/Pulsing41PostingsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Pulsing/Pulsing41PostingsFormat.cs b/src/Lucene.Net.Codecs/Pulsing/Pulsing41PostingsFormat.cs index dc1958d..5424996 100644 --- a/src/Lucene.Net.Codecs/Pulsing/Pulsing41PostingsFormat.cs +++ b/src/Lucene.Net.Codecs/Pulsing/Pulsing41PostingsFormat.cs @@ -20,8 +20,8 @@ namespace Lucene.Net.Codecs.Pulsing */ /// <summary> - /// Concrete pulsing implementation over {@link Lucene41PostingsFormat}. - /// + /// Concrete pulsing implementation over <see cref="Lucene41PostingsFormat"/>. + /// <para/> /// @lucene.experimental /// </summary> [PostingsFormatName("Pulsing41")] // LUCENENET specific - using PostingsFormatName attribute to ensure the default name passed from subclasses is the same as this class name @@ -33,13 +33,13 @@ namespace Lucene.Net.Codecs.Pulsing { } - /// <summary>Inlines docFreq=<code>freqCutoff</code> terms, otherwise uses the normal "Lucene41" format.</summary> + /// <summary>Inlines docFreq=<paramref name="freqCutoff"/> terms, otherwise uses the normal "Lucene41" format.</summary> public Pulsing41PostingsFormat(int freqCutoff) : this(freqCutoff, BlockTreeTermsWriter.DEFAULT_MIN_BLOCK_SIZE, BlockTreeTermsWriter.DEFAULT_MAX_BLOCK_SIZE) { } - /// <summary>Inlines docFreq=<code>freqCutoff</code> terms, otherwise uses the normal "Lucene41" format.</summary> + /// <summary>Inlines docFreq=<paramref name="freqCutoff"/> terms, otherwise uses the normal "Lucene41" format.</summary> public Pulsing41PostingsFormat(int freqCutoff, int minBlockSize, int maxBlockSize) : base(new Lucene41PostingsBaseFormat(), freqCutoff, minBlockSize, maxBlockSize) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsFormat.cs b/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsFormat.cs index 47a804d..550c422 100644 --- a/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsFormat.cs +++ b/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsFormat.cs @@ -25,6 +25,7 @@ namespace Lucene.Net.Codecs.Pulsing /// This postings format "inlines" the postings for terms that have /// low docFreq. It wraps another postings format, which is used for /// writing the non-inlined terms. + /// <para/> /// @lucene.experimental /// </summary> public abstract class PulsingPostingsFormat : PostingsFormat @@ -40,7 +41,7 @@ namespace Lucene.Net.Codecs.Pulsing { } - /// <summary>Terms with freq less than or equal freqCutoff are inlined into terms dict.</summary> + /// <summary>Terms with freq less than or equal <paramref name="freqCutoff"/> are inlined into terms dict.</summary> public PulsingPostingsFormat(PostingsBaseFormat wrappedPostingsBaseFormat, int freqCutoff, int minBlockSize, int maxBlockSize) : base() http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsReader.cs b/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsReader.cs index 1e8a23d..9b3627d 100644 --- a/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsReader.cs +++ b/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsReader.cs @@ -27,14 +27,13 @@ namespace Lucene.Net.Codecs.Pulsing */ /// <summary> - /// Concrete class that reads the current doc/freq/skip postings format - /// + /// Concrete class that reads the current doc/freq/skip postings format. + /// <para/> /// @lucene.experimental - /// - /// TODO: -- should we switch "hasProx" higher up? and - /// create two separate docs readers, one that also reads - /// prox and one that doesn't? /// </summary> + // TODO: -- should we switch "hasProx" higher up? and + // create two separate docs readers, one that also reads + // prox and one that doesn't? public class PulsingPostingsReader : PostingsReaderBase { // Fallback reader for non-pulsed terms: @@ -651,11 +650,11 @@ namespace Lucene.Net.Codecs.Pulsing } /// <summary> - /// for a docsenum, gets the 'other' reused enum. + /// For a docsenum, gets the 'other' reused enum. /// Example: Pulsing(Standard). - /// when doing a term range query you are switching back and forth - /// between Pulsing and Standard - /// + /// When doing a term range query you are switching back and forth + /// between Pulsing and Standard. + /// <para/> /// The way the reuse works is that Pulsing.other = Standard and /// Standard.other = Pulsing. /// </summary> @@ -671,8 +670,8 @@ namespace Lucene.Net.Codecs.Pulsing } /// <summary> - /// for a docsenum, sets the 'other' reused enum. - /// see GetOther for an example. + /// For a docsenum, sets the 'other' reused enum. + /// see <see cref="GetOther(DocsEnum)"/> for an example. /// </summary> private DocsEnum SetOther(DocsEnum de, DocsEnum other) { @@ -684,7 +683,7 @@ namespace Lucene.Net.Codecs.Pulsing /// A per-docsenum attribute that stores additional reuse information /// so that pulsing enums can keep a reference to their wrapped enums, /// and vice versa. this way we can always reuse. - /// + /// <para/> /// @lucene.internal /// </summary> public interface IPulsingEnumAttribute : IAttribute @@ -693,9 +692,9 @@ namespace Lucene.Net.Codecs.Pulsing } /// <summary> - /// Implementation of {@link PulsingEnumAttribute} for reuse of + /// Implementation of <see cref="PulsingEnumAttribute"/> for reuse of /// wrapped postings readers underneath pulsing. - /// + /// <para/> /// @lucene.internal /// </summary> public sealed class PulsingEnumAttribute : Util.Attribute, IPulsingEnumAttribute http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsWriter.cs b/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsWriter.cs index 3cae4d2..c515426 100644 --- a/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsWriter.cs +++ b/src/Lucene.Net.Codecs/Pulsing/PulsingPostingsWriter.cs @@ -23,20 +23,20 @@ namespace Lucene.Net.Codecs.Pulsing * limitations under the License. */ + // TODO: we now inline based on total TF of the term, + // but it might be better to inline by "net bytes used" + // so that a term that has only 1 posting but a huge + // payload would not be inlined. Though this is + // presumably rare in practice... + /// <summary> - /// TODO: we now inline based on total TF of the term, - /// but it might be better to inline by "net bytes used" - /// so that a term that has only 1 posting but a huge - /// payload would not be inlined. Though this is - /// presumably rare in practice... - /// /// Writer for the pulsing format. - /// + /// <para/> /// Wraps another postings implementation and decides /// (based on total number of occurrences), whether a terms /// postings should be inlined into the term dictionary, /// or passed through to the wrapped writer. - /// + /// <para/> /// @lucene.experimental /// </summary> public sealed class PulsingPostingsWriter : PostingsWriterBase @@ -96,7 +96,7 @@ namespace Lucene.Net.Codecs.Pulsing internal int FieldNumber { get; private set; } /// <summary> - /// NOTE: This was longsSize (field) in Lucene + /// NOTE: This was longsSize (field) in Lucene. /// </summary> internal int Int64sSize { get; private set; } @@ -115,8 +115,8 @@ namespace Lucene.Net.Codecs.Pulsing /// <summary> /// If the total number of positions (summed across all docs - /// for this term) is less than or equal maxPositions, then the postings are - /// inlined into terms dict + /// for this term) is less than or equal <paramref name="maxPositions"/>, then the postings are + /// inlined into terms dict. /// </summary> public PulsingPostingsWriter(SegmentWriteState state, int maxPositions, PostingsWriterBase wrappedPostingsWriter) { @@ -152,14 +152,13 @@ namespace Lucene.Net.Codecs.Pulsing Debug.Assert(_pendingCount == 0); } + // TODO: -- should we NOT reuse across fields? would + // be cleaner + /// <summary> - /// TODO: -- should we NOT reuse across fields? would - /// be cleaner /// Currently, this instance is re-used across fields, so - /// our parent calls setField whenever the field changes + /// our parent calls setField whenever the field changes. /// </summary> - /// <param name="fieldInfo"></param> - /// <returns></returns> public override int SetField(FieldInfo fieldInfo) { _indexOptions = fieldInfo.IndexOptions; @@ -261,9 +260,8 @@ namespace Lucene.Net.Codecs.Pulsing private readonly RAMOutputStream _buffer = new RAMOutputStream(); /// <summary> - /// Called when we are done adding docs to this term + /// Called when we are done adding docs to this term. /// </summary> - /// <param name="state"></param> public override void FinishTerm(BlockTermState state) { var state2 = (PulsingTermState)state; @@ -465,7 +463,9 @@ namespace Lucene.Net.Codecs.Pulsing } } - // Pushes pending positions to the wrapped codec + /// <summary> + /// Pushes pending positions to the wrapped codec. + /// </summary> private void Push() { Debug.Assert(_pendingCount == _pending.Length); http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Sep/IntIndexInput.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Sep/IntIndexInput.cs b/src/Lucene.Net.Codecs/Sep/IntIndexInput.cs index 9a3aabb..dbc343c 100644 --- a/src/Lucene.Net.Codecs/Sep/IntIndexInput.cs +++ b/src/Lucene.Net.Codecs/Sep/IntIndexInput.cs @@ -22,11 +22,10 @@ namespace Lucene.Net.Codecs.Sep /// <summary> /// Defines basic API for writing ints to an <see cref="IndexOutput"/>. - /// IntBlockCodec interacts with this API. @see - /// IntBlockReader + /// IntBlockCodec interacts with this API. See IntBlockReader. /// <para/> /// NOTE: This was IntIndexInput in Lucene - /// + /// <para/> /// @lucene.experimental /// </summary> public abstract class Int32IndexInput : IDisposable @@ -44,12 +43,12 @@ namespace Lucene.Net.Codecs.Sep public abstract Index GetIndex(); /// <summary> - /// Records a single skip-point in the <see cref="Int32IndexInput.GetReader"/>. </summary> + /// Records a single skip-point in the <see cref="Int32IndexInput.GetReader()"/>. </summary> public abstract class Index { public abstract void Read(DataInput indexIn, bool absolute); - /// <summary>Seeks primary stream to the last read offset </summary> + /// <summary>Seeks primary stream to the last read offset. </summary> public abstract void Seek(Reader stream); public abstract void CopyFrom(Index other); @@ -57,10 +56,10 @@ namespace Lucene.Net.Codecs.Sep public abstract object Clone(); } - /// <summary>Reads int values</summary> + /// <summary>Reads <see cref="int"/> values.</summary> public abstract class Reader { - /// <summary>Reads next single int</summary> + /// <summary>Reads next single <see cref="int"/>.</summary> public abstract int Next(); } } http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Sep/IntIndexOutput.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Sep/IntIndexOutput.cs b/src/Lucene.Net.Codecs/Sep/IntIndexOutput.cs index 5d97def..81fb248 100644 --- a/src/Lucene.Net.Codecs/Sep/IntIndexOutput.cs +++ b/src/Lucene.Net.Codecs/Sep/IntIndexOutput.cs @@ -20,47 +20,46 @@ namespace Lucene.Net.Codecs.Sep * limitations under the License. */ + // TODO: We may want tighter integration w/IndexOutput + // may give better performance + /// <summary> - /// Defines basic API for writing ints to an IndexOutput. - /// IntBlockCodec interacts with this API. @see IntBlockReader. - /// + /// Defines basic API for writing ints to an <see cref="IndexOutput"/>. + /// IntBlockCodec interacts with this API. See IntBlockReader. + /// <para/> /// NOTE: block sizes could be variable /// <para/> /// NOTE: This was IntIndexOutput in Lucene - /// + /// <para/> /// @lucene.experimental /// </summary> - /// <remarks> - /// TODO: We may want tighter integration w/IndexOutput - /// may give better performance - /// </remarks> public abstract class Int32IndexOutput : IDisposable { /// <summary> - /// Write an int to the primary file. The value must be + /// Write an <see cref="int"/> to the primary file. The value must be /// >= 0. /// </summary> public abstract void Write(int v); - /// <summary>Records a single skip-point in the IndexOutput. </summary> + /// <summary>Records a single skip-point in the <see cref="IndexOutput"/>. </summary> public abstract class Index { - /// <summary>Internally records the current location </summary> + /// <summary>Internally records the current location. </summary> public abstract void Mark(); - /// <summary>Copies index from other </summary> + /// <summary>Copies index from <paramref name="other"/>. </summary> public abstract void CopyFrom(Index other, bool copyLast); /// <summary> /// Writes "location" of current output pointer of primary - /// output to different output (out) + /// output to different output (out). /// </summary> public abstract void Write(DataOutput indexOut, bool absolute); } /// <summary> /// If you are indexing the primary output file, call - /// this and interact with the returned IndexWriter. + /// this and interact with the returned IndexWriter. /// </summary> public abstract Index GetIndex(); http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Sep/IntStreamFactory.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Sep/IntStreamFactory.cs b/src/Lucene.Net.Codecs/Sep/IntStreamFactory.cs index 09f0915..78dd90c 100644 --- a/src/Lucene.Net.Codecs/Sep/IntStreamFactory.cs +++ b/src/Lucene.Net.Codecs/Sep/IntStreamFactory.cs @@ -20,21 +20,21 @@ namespace Lucene.Net.Codecs.Sep */ /// <summary> - /// Provides int reader and writer to specified files. + /// Provides <see cref="int"/> reader and writer to specified files. /// <para/> /// NOTE: This was IntStreamFactory in Lucene - /// + /// <para/> /// @lucene.experimental /// </summary> public abstract class Int32StreamFactory { /// <summary> - /// Create an <seealso cref="Int32IndexInput"/> on the provided fileName. + /// Create an <see cref="Int32IndexInput"/> on the provided fileName. /// </summary> public abstract Int32IndexInput OpenInput(Directory dir, string fileName, IOContext context); /// <summary> - /// Create an <seealso cref="Int32IndexOutput"/> on the provided fileName. + /// Create an <see cref="Int32IndexOutput"/> on the provided fileName. /// </summary> public abstract Int32IndexOutput CreateOutput(Directory dir, string fileName, IOContext context); } http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Sep/SepPostingsReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Sep/SepPostingsReader.cs b/src/Lucene.Net.Codecs/Sep/SepPostingsReader.cs index 0ae52cf..90fb85e 100644 --- a/src/Lucene.Net.Codecs/Sep/SepPostingsReader.cs +++ b/src/Lucene.Net.Codecs/Sep/SepPostingsReader.cs @@ -22,17 +22,16 @@ namespace Lucene.Net.Codecs.Sep * limitations under the License. */ + // TODO: -- should we switch "hasProx" higher up? and + // create two separate docs readers, one that also reads + // prox and one that doesn't? + /// <summary> /// Concrete class that reads the current doc/freq/skip /// postings format. - /// + /// <para/> /// @lucene.experimental /// </summary> - /// <remarks> - /// TODO: -- should we switch "hasProx" higher up? and - /// create two separate docs readers, one that also reads - /// prox and one that doesn't? - /// </remarks> public class SepPostingsReader : PostingsReaderBase { private readonly Int32IndexInput freqIn; http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Sep/SepPostingsWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Sep/SepPostingsWriter.cs b/src/Lucene.Net.Codecs/Sep/SepPostingsWriter.cs index dbfe65e..9a1e895 100644 --- a/src/Lucene.Net.Codecs/Sep/SepPostingsWriter.cs +++ b/src/Lucene.Net.Codecs/Sep/SepPostingsWriter.cs @@ -25,7 +25,7 @@ namespace Lucene.Net.Codecs.Sep /// <summary> /// Writes frq to .frq, docs to .doc, pos to .pos, payloads /// to .pyl, skip data to .skp - /// + /// <para/> /// @lucene.experimental /// </summary> public sealed class SepPostingsWriter : PostingsWriterBase @@ -59,7 +59,7 @@ namespace Lucene.Net.Codecs.Sep /// <summary> /// Expert: The fraction of TermDocs entries stored in skip tables, - /// used to accelerate <seealso cref="DocsEnum#advance(int)"/>. Larger values result in + /// used to accelerate <see cref="Lucene.Net.Search.DocIdSetIterator.Advance(int)"/>. Larger values result in /// smaller indexes, greater acceleration, but fewer accelerable cases, while /// smaller values result in bigger indexes, less acceleration and more /// accelerable cases. More detailed experiments would be useful here. @@ -68,7 +68,7 @@ namespace Lucene.Net.Codecs.Sep private static readonly int DEFAULT_SKIP_INTERVAL = 16; /// <summary> - /// Expert: minimum docFreq to write any skip data at all + /// Expert: minimum docFreq to write any skip data at all. /// </summary> private readonly int skipMinimum; @@ -225,8 +225,8 @@ namespace Lucene.Net.Codecs.Sep } /// <summary> - /// Adds a new doc in this term. If this returns null - /// then we just skip consuming positions/payloads. + /// Adds a new doc in this term. If this returns <c>null</c> + /// then we just skip consuming positions/payloads. /// </summary> public override void StartDoc(int docID, int termDocFreq) { @@ -257,7 +257,7 @@ namespace Lucene.Net.Codecs.Sep } /// <summary> - /// Add a new position & payload </summary> + /// Add a new position & payload. </summary> public override void AddPosition(int position, BytesRef payload, int startOffset, int endOffset) { Debug.Assert(indexOptions == IndexOptions.DOCS_AND_FREQS_AND_POSITIONS); @@ -295,7 +295,7 @@ namespace Lucene.Net.Codecs.Sep lastPosition = position; } - /// <summary>Called when we are done adding positions & payloads </summary> + /// <summary>Called when we are done adding positions & payloads. </summary> public override void FinishDoc() { lastPosition = 0; @@ -310,7 +310,7 @@ namespace Lucene.Net.Codecs.Sep public long SkipFP { get; set; } } - /// <summary>Called when we are done adding docs to this term </summary> + /// <summary>Called when we are done adding docs to this term. </summary> public override void FinishTerm(BlockTermState state) { SepTermState state_ = (SepTermState)state; http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Sep/SepSkipListReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Sep/SepSkipListReader.cs b/src/Lucene.Net.Codecs/Sep/SepSkipListReader.cs index 1b2a737..5cc9df4 100644 --- a/src/Lucene.Net.Codecs/Sep/SepSkipListReader.cs +++ b/src/Lucene.Net.Codecs/Sep/SepSkipListReader.cs @@ -25,7 +25,7 @@ namespace Lucene.Net.Codecs.Sep /// <summary> /// Implements the skip list reader for the default posting list format /// that stores positions and payloads. - /// + /// <para/> /// @lucene.experimental /// </summary> @@ -126,7 +126,7 @@ namespace Lucene.Net.Codecs.Sep /// <summary> /// Returns the payload length of the payload stored just before - /// the doc to which the last call of <seealso cref="MultiLevelSkipListReader#skipTo(int)"/> + /// the doc to which the last call of <see cref="MultiLevelSkipListReader.SkipTo(int)"/> /// has skipped. /// </summary> internal virtual int PayloadLength http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/Sep/SepSkipListWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/Sep/SepSkipListWriter.cs b/src/Lucene.Net.Codecs/Sep/SepSkipListWriter.cs index 21c6209..5d3acb5 100644 --- a/src/Lucene.Net.Codecs/Sep/SepSkipListWriter.cs +++ b/src/Lucene.Net.Codecs/Sep/SepSkipListWriter.cs @@ -22,16 +22,15 @@ namespace Lucene.Net.Codecs.Sep * limitations under the License. */ + // TODO: -- skip data should somehow be more local to the particular stream + // (doc, freq, pos, payload) + /// <summary> /// Implements the skip list writer for the default posting list format /// that stores positions and payloads. - /// + /// <para/> /// @lucene.experimental /// </summary> - /// <remarks> - /// TODO: -- skip data should somehow be more local to the particular stream - /// (doc, freq, pos, payload) - /// </remarks> internal class SepSkipListWriter : MultiLevelSkipListWriter { private readonly int[] _lastSkipDoc; @@ -108,7 +107,7 @@ namespace Lucene.Net.Codecs.Sep /// <summary> /// Sets the values for the current skip data. - /// Called @ every index interval (every 128th (by default) doc) + /// Called @ every index interval (every 128th (by default) doc). /// </summary> internal virtual void SetSkipData(int doc, bool storePayloads, int payloadLength) { @@ -122,7 +121,7 @@ namespace Lucene.Net.Codecs.Sep } /// <summary> - /// Called @ start of new term + /// Called @ start of new term. /// </summary> protected internal virtual void ResetSkip(Int32IndexOutput.Index topDocIndex, Int32IndexOutput.Index topFreqIndex, Int32IndexOutput.Index topPosIndex) http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextCodec.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextCodec.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextCodec.cs index 875e519..8d9573a 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextCodec.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextCodec.cs @@ -18,11 +18,11 @@ */ /// <summary> - /// plain text index format. + /// Plain text index format. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> [CodecName("SimpleText")] // LUCENENET specific - using CodecName attribute to ensure the default name passed from subclasses is the same as this class name public sealed class SimpleTextCodec : Codec http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextDocValuesFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextDocValuesFormat.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextDocValuesFormat.cs index a247080..e77b038 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextDocValuesFormat.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextDocValuesFormat.cs @@ -21,14 +21,14 @@ using SegmentWriteState = Index.SegmentWriteState; /// <summary> - /// plain text doc values format. + /// Plain text doc values format. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> /// <para> - /// the .dat file contains the data. - /// for numbers this is a "fixed-width" file, for example a single byte range: - /// <pre> + /// The .dat file contains the data. + /// For numbers this is a "fixed-width" file, for example a single byte range: + /// <code> /// field myField /// type NUMERIC /// minvalue 0 @@ -40,13 +40,13 @@ /// 123 /// T /// ... - /// </pre> - /// so a document's value (delta encoded from minvalue) can be retrieved by - /// seeking to startOffset + (1+pattern.length()+2)*docid. The extra 1 is the newline. - /// The extra 2 is another newline and 'T' or 'F': true if the value is real, false if missing. + /// </code> + /// So a document's value (delta encoded from minvalue) can be retrieved by + /// seeking to startOffset + (1+pattern.length()+2)*docid. The extra 1 is the newline. + /// The extra 2 is another newline and 'T' or 'F': true if the value is real, false if missing. /// - /// for bytes this is also a "fixed-width" file, for example: - /// <pre> + /// for bytes this is also a "fixed-width" file, for example: + /// <code> /// field myField /// type BINARY /// maxlength 6 @@ -58,13 +58,13 @@ /// baz[space][space][space][space][space] /// T /// ... - /// </pre> - /// so a doc's value can be retrieved by seeking to startOffset + (9+pattern.length+maxlength+2)*doc - /// the extra 9 is 2 newlines, plus "length " itself. - /// the extra 2 is another newline and 'T' or 'F': true if the value is real, false if missing. + /// </code> + /// So a doc's value can be retrieved by seeking to startOffset + (9+pattern.length+maxlength+2)*doc + /// the extra 9 is 2 newlines, plus "length " itself. + /// The extra 2 is another newline and 'T' or 'F': true if the value is real, false if missing. /// - /// for sorted bytes this is a fixed-width file, for example: - /// <pre> + /// For sorted bytes this is a fixed-width file, for example: + /// <code> /// field myField /// type SORTED /// numvalues 10 @@ -81,13 +81,13 @@ /// 01 /// 10 /// ... - /// </pre> - /// so the "ord section" begins at startOffset + (9+pattern.length+maxlength)*numValues. - /// a document's ord can be retrieved by seeking to "ord section" + (1+ordpattern.length())*docid - /// an ord's value can be retrieved by seeking to startOffset + (9+pattern.length+maxlength)*ord + /// </code> + /// So the "ord section" begins at startOffset + (9+pattern.length+maxlength)*numValues. + /// A document's ord can be retrieved by seeking to "ord section" + (1+ordpattern.length())*docid + /// an ord's value can be retrieved by seeking to startOffset + (9+pattern.length+maxlength)*ord /// - /// for sorted set this is a fixed-width file very similar to the SORTED case, for example: - /// <pre> + /// For sorted set this is a fixed-width file very similar to the SORTED case, for example: + /// <code> /// field myField /// type SORTED_SET /// numvalues 10 @@ -104,16 +104,17 @@ /// /// 10 /// ... - /// </pre> - /// so the "ord section" begins at startOffset + (9+pattern.length+maxlength)*numValues. - /// a document's ord list can be retrieved by seeking to "ord section" + (1+ordpattern.length())*docid - /// this is a comma-separated list, and its padded with spaces to be fixed width. so trim() and split() it. - /// and beware the empty string! - /// an ord's value can be retrieved by seeking to startOffset + (9+pattern.length+maxlength)*ord - /// - /// the reader can just scan this file when it opens, skipping over the data blocks - /// and saving the offset/etc for each field. - /// @lucene.experimental + /// </code> + /// So the "ord section" begins at startOffset + (9+pattern.length+maxlength)*numValues. + /// A document's ord list can be retrieved by seeking to "ord section" + (1+ordpattern.length())*docid + /// this is a comma-separated list, and its padded with spaces to be fixed width. so trim() and split() it. + /// and beware the empty string! + /// An ord's value can be retrieved by seeking to startOffset + (9+pattern.length+maxlength)*ord + /// <para/> + /// The reader can just scan this file when it opens, skipping over the data blocks + /// and saving the offset/etc for each field. + /// <para/> + /// @lucene.experimental /// </para> /// </summary> [DocValuesFormatName("SimpleText")] // LUCENENET specific - using DocValuesFormatName attribute to ensure the default name passed from subclasses is the same as this class name http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextDocValuesWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextDocValuesWriter.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextDocValuesWriter.cs index e319d6d..1a01db9 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextDocValuesWriter.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextDocValuesWriter.cs @@ -406,7 +406,7 @@ namespace Lucene.Net.Codecs.SimpleText } } - /// <summary>Write the header for this field </summary> + /// <summary>Write the header for this field. </summary> private void WriteFieldEntry(FieldInfo field, DocValuesType type) { SimpleTextUtil.Write(data, FIELD); http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosFormat.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosFormat.cs index 50ca57d..ea2ee27 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosFormat.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosFormat.cs @@ -18,11 +18,11 @@ */ /// <summary> - /// plaintext field infos format + /// Plain text field infos format. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextFieldInfosFormat : FieldInfosFormat { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosReader.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosReader.cs index 0d8d059..a53519a 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosReader.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosReader.cs @@ -35,11 +35,11 @@ namespace Lucene.Net.Codecs.SimpleText using StringHelper = Util.StringHelper; /// <summary> - /// reads plaintext field infos files + /// Reads plain text field infos files. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextFieldInfosReader : FieldInfosReader { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosWriter.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosWriter.cs index 75979c8..4e3eee1 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosWriter.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldInfosWriter.cs @@ -32,16 +32,16 @@ namespace Lucene.Net.Codecs.SimpleText using IOUtils = Util.IOUtils; /// <summary> - /// writes plaintext field infos files + /// Writes plain text field infos files. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextFieldInfosWriter : FieldInfosWriter { /// <summary> - /// Extension of field infos </summary> + /// Extension of field infos. </summary> internal const string FIELD_INFOS_EXTENSION = "inf"; internal static readonly BytesRef NUMFIELDS = new BytesRef("number of fields "); http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldsReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldsReader.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldsReader.cs index 5d57d4f..a7c33f8 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldsReader.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextFieldsReader.cs @@ -673,7 +673,7 @@ namespace Lucene.Net.Codecs.SimpleText } - /// <summary>Returns approximate RAM bytes used</summary> + /// <summary>Returns approximate RAM bytes used.</summary> public virtual long RamBytesUsed() { return (_fst != null) ? _fst.GetSizeInBytes() : 0; http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextLiveDocsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextLiveDocsFormat.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextLiveDocsFormat.cs index e1d9cfd..ef1c6d2 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextLiveDocsFormat.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextLiveDocsFormat.cs @@ -40,11 +40,11 @@ namespace Lucene.Net.Codecs.SimpleText using UnicodeUtil = Util.UnicodeUtil; /// <summary> - /// reads/writes plaintext live docs + /// Reads/writes plain text live docs. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextLiveDocsFormat : LiveDocsFormat { @@ -113,7 +113,7 @@ namespace Lucene.Net.Codecs.SimpleText } /// <summary> - /// NOTE: This was parseIntAt() in Lucene + /// NOTE: This was parseIntAt() in Lucene. /// </summary> private int ParseInt32At(BytesRef bytes, int offset, CharsRef scratch) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextNormsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextNormsFormat.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextNormsFormat.cs index 3336938..fdc5864 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextNormsFormat.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextNormsFormat.cs @@ -21,12 +21,11 @@ using SegmentWriteState = Index.SegmentWriteState; /// <summary> - /// plain-text norms format. + /// Plain-text norms format. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextNormsFormat : NormsFormat { @@ -45,10 +44,9 @@ /// <summary> /// Reads plain-text norms. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextNormsProducer : SimpleTextDocValuesReader { @@ -63,10 +61,9 @@ /// <summary> /// Writes plain-text norms. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextNormsConsumer : SimpleTextDocValuesWriter { @@ -78,5 +75,4 @@ } } } - } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextPostingsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextPostingsFormat.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextPostingsFormat.cs index da42168..413dffa 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextPostingsFormat.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextPostingsFormat.cs @@ -23,14 +23,13 @@ /// <summary> /// For debugging, curiosity, transparency only!! Do not - /// use this codec in production. + /// use this codec in production. /// - /// <para>This codec stores all postings data in a single - /// human-readable text file (_N.pst). You can view this in - /// any text editor, and even edit it to alter your index. - /// - /// @lucene.experimental + /// <para>This codec stores all postings data in a single + /// human-readable text file (_N.pst). You can view this in + /// any text editor, and even edit it to alter your index. /// </para> + /// @lucene.experimental /// </summary> [PostingsFormatName("SimpleText")] // LUCENENET specific - using PostingsFormatName attribute to ensure the default name passed from subclasses is the same as this class name public sealed class SimpleTextPostingsFormat : PostingsFormat @@ -51,7 +50,7 @@ } /// <summary> - /// Extension of freq postings file </summary> + /// Extension of freq postings file. </summary> internal const string POSTINGS_EXTENSION = "pst"; internal static string GetPostingsFileName(string segment, string segmentSuffix) http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoFormat.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoFormat.cs index ef3cc4c..8db197c 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoFormat.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoFormat.cs @@ -18,11 +18,11 @@ */ /// <summary> - /// plain text segments file format. + /// Plain text segments file format. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextSegmentInfoFormat : SegmentInfoFormat { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoReader.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoReader.cs index 000f212..6e7a072 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoReader.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoReader.cs @@ -33,11 +33,11 @@ namespace Lucene.Net.Codecs.SimpleText using StringHelper = Util.StringHelper; /// <summary> - /// reads plaintext segments files + /// Reads plaintext segments files. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextSegmentInfoReader : SegmentInfoReader { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoWriter.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoWriter.cs index d12df2f..e966a7c 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoWriter.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextSegmentInfoWriter.cs @@ -30,11 +30,11 @@ namespace Lucene.Net.Codecs.SimpleText using SegmentInfo = Index.SegmentInfo; /// <summary> - /// writes plaintext segments files + /// Writes plain text segments files. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextSegmentInfoWriter : SegmentInfoWriter { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsFormat.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsFormat.cs index 5a89edd..7143992 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsFormat.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsFormat.cs @@ -23,11 +23,11 @@ using IOContext = Store.IOContext; /// <summary> - /// plain text stored fields format. + /// Plain text stored fields format. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextStoredFieldsFormat : StoredFieldsFormat { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsReader.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsReader.cs index 032c9e4..9131d31 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsReader.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsReader.cs @@ -41,11 +41,11 @@ namespace Lucene.Net.Codecs.SimpleText using UnicodeUtil = Util.UnicodeUtil; /// <summary> - /// reads plaintext stored fields + /// Reads plain text stored fields. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextStoredFieldsReader : StoredFieldsReader { @@ -84,7 +84,7 @@ namespace Lucene.Net.Codecs.SimpleText ReadIndex(si.DocCount); } - /// <remarks>Used by clone</remarks> + /// <remarks>Used by clone.</remarks> internal SimpleTextStoredFieldsReader(long[] offsets, IndexInput input, FieldInfos fieldInfos) { _offsets = offsets; @@ -93,7 +93,7 @@ namespace Lucene.Net.Codecs.SimpleText } /// <remarks> - /// we don't actually write a .fdx-like index, instead we read the + /// We don't actually write a .fdx-like index, instead we read the /// stored fields file in entirety up-front and save the offsets /// so we can seek to the documents later. /// </remarks> @@ -250,7 +250,7 @@ namespace Lucene.Net.Codecs.SimpleText } /// <summary> - /// NOTE: This was parseIntAt() in Lucene + /// NOTE: This was parseIntAt() in Lucene. /// </summary> private int ParseInt32At(int offset) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsWriter.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsWriter.cs index 67c5cc5..ae67cc3 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsWriter.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextStoredFieldsWriter.cs @@ -33,9 +33,9 @@ namespace Lucene.Net.Codecs.SimpleText /// <summary> /// Writes plain-text stored fields. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextStoredFieldsWriter : StoredFieldsWriter { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsFormat.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsFormat.cs index a8d38fe..9782e1a 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsFormat.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsFormat.cs @@ -23,11 +23,11 @@ using IOContext = Store.IOContext; /// <summary> - /// plain text term vectors format. + /// Plain text term vectors format. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextTermVectorsFormat : TermVectorsFormat { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsReader.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsReader.cs index 95c50d6..a4d7fc5 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsReader.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsReader.cs @@ -48,9 +48,9 @@ namespace Lucene.Net.Codecs.SimpleText /// <summary> /// Reads plain-text term vectors. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextTermVectorsReader : TermVectorsReader { @@ -259,7 +259,7 @@ namespace Lucene.Net.Codecs.SimpleText } /// <summary> - /// NOTE: This was parseIntAt() in Lucene + /// NOTE: This was parseIntAt() in Lucene. /// </summary> private int ParseInt32At(int offset) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/666de32b/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsWriter.cs b/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsWriter.cs index b9d0bb6..c376c46 100644 --- a/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsWriter.cs +++ b/src/Lucene.Net.Codecs/SimpleText/SimpleTextTermVectorsWriter.cs @@ -34,9 +34,9 @@ namespace Lucene.Net.Codecs.SimpleText /// <summary> /// Writes plain-text term vectors. /// <para> - /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></B> - /// @lucene.experimental + /// <b><font color="red">FOR RECREATIONAL USE ONLY</font></b> /// </para> + /// @lucene.experimental /// </summary> public class SimpleTextTermVectorsWriter : TermVectorsWriter {
