lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From synhers...@apache.org
Subject lucenenet git commit: Fixing docs
Date Tue, 26 Apr 2016 20:47:04 GMT
Repository: lucenenet
Updated Branches:
  refs/heads/master 3277316e9 -> 4db724fd1


Fixing docs


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

Branch: refs/heads/master
Commit: 4db724fd19737039e1ce388708344dfd8443fff5
Parents: 3277316
Author: Itamar Syn-Hershko <Itamar Syn-Hershko>
Authored: Tue Apr 26 23:46:41 2016 +0300
Committer: Itamar Syn-Hershko <Itamar Syn-Hershko>
Committed: Tue Apr 26 23:46:41 2016 +0300

----------------------------------------------------------------------
 .../Document/BinaryDocValuesField.cs            |  5 ++-
 .../Document/ByteDocValuesField.cs              | 10 ++----
 .../Document/DerefBytesDocValuesField.cs        | 10 +++---
 src/Lucene.Net.Core/Document/Document.cs        | 38 ++++++++++----------
 .../Document/DoubleDocValuesField.cs            |  6 ++--
 src/Lucene.Net.Core/Document/DoubleField.cs     |  8 ++---
 .../Document/FloatDocValuesField.cs             |  4 +--
 src/Lucene.Net.Core/Document/FloatField.cs      |  8 ++---
 .../Document/IntDocValuesField.cs               | 13 ++++---
 src/Lucene.Net.Core/Document/IntField.cs        |  7 ++--
 .../Document/LongDocValuesField.cs              | 11 +++---
 src/Lucene.Net.Core/Document/LongField.cs       | 13 +++----
 .../Document/NumericDocValuesField.cs           |  4 ---
 .../Document/SortedDocValuesField.cs            |  6 ++--
 src/Lucene.Net.Core/Document/StoredField.cs     | 20 +++++------
 src/Lucene.Net.Core/Document/StringField.cs     |  6 ++--
 16 files changed, 80 insertions(+), 89 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/BinaryDocValuesField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/BinaryDocValuesField.cs b/src/Lucene.Net.Core/Document/BinaryDocValuesField.cs
index 0c3edfe..07d672a 100644
--- a/src/Lucene.Net.Core/Document/BinaryDocValuesField.cs
+++ b/src/Lucene.Net.Core/Document/BinaryDocValuesField.cs
@@ -23,7 +23,7 @@ namespace Lucene.Net.Documents
 
     /// <summary>
     /// Field that stores a per-document <seealso cref="BytesRef"/> value.
-    /// <p>
+    /// 
     /// The values are stored directly with no sharing, which is a good fit when
     /// the fields don't share (many) values, such as a title field.  If values
     /// may be shared and sorted it's better to use <seealso cref="SortedDocValuesField"/>.
@@ -33,11 +33,10 @@ namespace Lucene.Net.Documents
     ///   document.add(new BinaryDocValuesField(name, new BytesRef("hello")));
     /// </pre>
     ///
-    /// <p>
     /// If you also need to store the value, you should add a
     /// separate <seealso cref="StoredField"/> instance.
     /// </summary>
-    /// <seealso cref= BinaryDocValues</seealso>
+    /// <seealso cref="BinaryDocValues"/>
     public class BinaryDocValuesField : Field
     {
         /// <summary>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/ByteDocValuesField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/ByteDocValuesField.cs b/src/Lucene.Net.Core/Document/ByteDocValuesField.cs
index 316c555..3920aec 100644
--- a/src/Lucene.Net.Core/Document/ByteDocValuesField.cs
+++ b/src/Lucene.Net.Core/Document/ByteDocValuesField.cs
@@ -1,4 +1,5 @@
 using System;
+using Lucene.Net.Index;
 
 
 namespace Lucene.Net.Documents
@@ -21,7 +22,6 @@ namespace Lucene.Net.Documents
      */
 
     /// <summary>
-    /// <p>
     /// Field that stores a per-document <code>byte</code> value for scoring,
     /// sorting or value retrieval. Here's an example usage:
     ///
@@ -29,15 +29,11 @@ namespace Lucene.Net.Documents
     ///   document.add(new ByteDocValuesField(name, (byte) 22));
     /// </pre>
     ///
-    /// <p>
     /// If you also need to store the value, you should add a
     /// separate <seealso cref="StoredField"/> instance.
     /// </summary>
-    /// <seealso cref= NumericDocValues </seealso>
-    /// @deprecated use <seealso cref="NumericDocValuesField"/> instead.
-    ///
-
-    [Obsolete]
+    /// <seealso cref="NumericDocValues"/>
+    [Obsolete("Use NumericDocValuesField instead")]
     public class ByteDocValuesField : NumericDocValuesField
     {
         /// <summary>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/DerefBytesDocValuesField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/DerefBytesDocValuesField.cs b/src/Lucene.Net.Core/Document/DerefBytesDocValuesField.cs
index 2b91e3d..e84b889 100644
--- a/src/Lucene.Net.Core/Document/DerefBytesDocValuesField.cs
+++ b/src/Lucene.Net.Core/Document/DerefBytesDocValuesField.cs
@@ -1,4 +1,6 @@
 
+using System;
+using Lucene.Net.Index;
 using Lucene.Net.Util;
 
 namespace Lucene.Net.Documents
@@ -20,7 +22,6 @@ namespace Lucene.Net.Documents
      * limitations under the License.
      */
     /// <summary>
-    /// <p>
     /// Field that stores
     /// a per-document <seealso cref="BytesRef"/> value. Here's an example usage:
     ///
@@ -28,14 +29,11 @@ namespace Lucene.Net.Documents
     ///   document.add(new DerefBytesDocValuesField(name, new BytesRef("hello")));
     /// </pre>
     ///
-    /// <p>
     /// If you also need to store the value, you should add a
     /// separate <seealso cref="StoredField"/> instance.
     /// </summary>
-    /// <seealso cref= BinaryDocValues </seealso>
-    /// @deprecated Use <seealso cref="BinaryDocValuesField"/> instead.
-    ///
-    ///[Obsolete("Use <seealso cref="BinaryDocValuesField"/> instead.")]
+    /// <seealso cref="BinaryDocValues"/>
+    [Obsolete("Use BinaryDocValuesField instead.")]
     public class DerefBytesDocValuesField : BinaryDocValuesField
     {
         /// <summary>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/Document.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/Document.cs b/src/Lucene.Net.Core/Document/Document.cs
index 9546cc1..637b886 100644
--- a/src/Lucene.Net.Core/Document/Document.cs
+++ b/src/Lucene.Net.Core/Document/Document.cs
@@ -39,7 +39,7 @@ namespace Lucene.Net.Documents
     /// </summary>
     public sealed class Document : IEnumerable<IndexableField>
     {
-        private readonly List<IndexableField> Fields_Renamed = new List<IndexableField>();
+        private readonly List<IndexableField> fields = new List<IndexableField>();
 
         /// <summary>
         /// Constructs a new document with no fields. </summary>
@@ -49,7 +49,7 @@ namespace Lucene.Net.Documents
 
         public IEnumerator<IndexableField> GetEnumerator()
         {
-            return Fields_Renamed.GetEnumerator();
+            return fields.GetEnumerator();
         }
 
         IEnumerator IEnumerable.GetEnumerator()
@@ -69,7 +69,7 @@ namespace Lucene.Net.Documents
         /// </summary>
         public void Add(IndexableField field)
         {
-            Fields_Renamed.Add(field);
+            fields.Add(field);
         }
 
         /// <summary>
@@ -84,13 +84,13 @@ namespace Lucene.Net.Documents
         /// </summary>
         public void RemoveField(string name)
         {
-            for (int i = Fields_Renamed.Count - 1; i >= 0; i--)
+            for (int i = fields.Count - 1; i >= 0; i--)
             {
-                IndexableField field = Fields_Renamed[i];
+                IndexableField field = fields[i];
 
                 if (field.Name().Equals(name))
                 {
-                    Fields_Renamed.RemoveAt(i);
+                    fields.RemoveAt(i);
                     return;
                 }
             }
@@ -107,13 +107,13 @@ namespace Lucene.Net.Documents
         /// </summary>
         public void RemoveFields(string name)
         {
-            for (int i = Fields_Renamed.Count - 1; i >= 0; i--)
+            for (int i = fields.Count - 1; i >= 0; i--)
             {
-                IndexableField field = Fields_Renamed[i];
+                IndexableField field = fields[i];
 
                 if (field.Name().Equals(name))
                 {
-                    Fields_Renamed.RemoveAt(i);
+                    fields.RemoveAt(i);
                 }
             }
         }
@@ -130,7 +130,7 @@ namespace Lucene.Net.Documents
         {
             var result = new List<BytesRef>();
 
-            foreach (IndexableField field in Fields_Renamed)
+            foreach (IndexableField field in fields)
             {
                 if (field.Name().Equals(name))
                 {
@@ -156,7 +156,7 @@ namespace Lucene.Net.Documents
         /// <returns> a <code>BytesRef</code> containing the binary field
value or <code>null</code> </returns>
         public BytesRef GetBinaryValue(string name)
         {
-            foreach (IndexableField field in Fields_Renamed)
+            foreach (IndexableField field in fields)
             {
                 if (field.Name().Equals(name))
                 {
@@ -177,7 +177,7 @@ namespace Lucene.Net.Documents
         /// </summary>
         public IndexableField GetField(string name)
         {
-            foreach (IndexableField field in Fields_Renamed)
+            foreach (IndexableField field in fields)
             {
                 if (field.Name().Equals(name))
                 {
@@ -197,7 +197,7 @@ namespace Lucene.Net.Documents
         public IndexableField[] GetFields(string name)
         {
             var result = new List<IndexableField>();
-            foreach (IndexableField field in Fields_Renamed)
+            foreach (IndexableField field in fields)
             {
                 if (field.Name().Equals(name))
                 {
@@ -219,7 +219,7 @@ namespace Lucene.Net.Documents
         {
             get
             {
-                return Fields_Renamed;
+                return fields;
             }
         }
 
@@ -237,7 +237,7 @@ namespace Lucene.Net.Documents
         public string[] GetValues(string name)
         {
             var result = new List<string>();
-            foreach (IndexableField field in Fields_Renamed)
+            foreach (IndexableField field in fields)
             {
                 if (field.Name().Equals(name) && field.StringValue != null)
                 {
@@ -264,7 +264,7 @@ namespace Lucene.Net.Documents
         /// </summary>
         public string Get(string name)
         {
-            foreach (IndexableField field in Fields_Renamed)
+            foreach (IndexableField field in fields)
             {
                 if (field.Name().Equals(name) && field.StringValue != null)
                 {
@@ -280,11 +280,11 @@ namespace Lucene.Net.Documents
         {
             var buffer = new StringBuilder();
             buffer.Append("Document<");
-            for (int i = 0; i < Fields_Renamed.Count; i++)
+            for (int i = 0; i < fields.Count; i++)
             {
-                IndexableField field = Fields_Renamed[i];
+                IndexableField field = fields[i];
                 buffer.Append(field.ToString());
-                if (i != Fields_Renamed.Count - 1)
+                if (i != fields.Count - 1)
                 {
                     buffer.Append(" ");
                 }

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/DoubleDocValuesField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/DoubleDocValuesField.cs b/src/Lucene.Net.Core/Document/DoubleDocValuesField.cs
index 598ed04..31a6bf7 100644
--- a/src/Lucene.Net.Core/Document/DoubleDocValuesField.cs
+++ b/src/Lucene.Net.Core/Document/DoubleDocValuesField.cs
@@ -27,10 +27,10 @@ namespace Lucene.Net.Documents
     /// <summary>
     /// Syntactic sugar for encoding doubles as NumericDocValues
     /// via <seealso cref="Double#doubleToRawLongBits(double)"/>.
-    /// <p>
+    /// 
     /// Per-document double values can be retrieved via
     /// <seealso cref="IFieldCache#getDoubles(AtomicReader, String, boolean)"/>.
-    /// <p>
+    /// 
     /// <b>NOTE</b>: In most all cases this will be rather inefficient,
     /// requiring eight bytes per document. Consider encoding double
     /// values yourself with only as much precision as you require.
@@ -41,7 +41,7 @@ namespace Lucene.Net.Documents
         /// Creates a new DocValues field with the specified 64-bit double value </summary>
         /// <param name="name"> field name </param>
         /// <param name="value"> 64-bit double value </param>
-        /// <exception cref="IllegalArgumentException"> if the field name is null </exception>
+        /// <exception cref="ArgumentException"> if the field name is null </exception>
         public DoubleDocValuesField(string name, double value)
             : base(name, BitConverter.DoubleToInt64Bits(value))
         {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/DoubleField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/DoubleField.cs b/src/Lucene.Net.Core/Document/DoubleField.cs
index b8f0a18..5200c2e 100644
--- a/src/Lucene.Net.Core/Document/DoubleField.cs
+++ b/src/Lucene.Net.Core/Document/DoubleField.cs
@@ -2,6 +2,7 @@ using System;
 
 using Lucene.Net.Index;
 using Lucene.Net.Search;
+using Lucene.Net.Util;
 
 namespace Lucene.Net.Documents
 {
@@ -52,7 +53,7 @@ namespace Lucene.Net.Documents
     /// </pre>
     ///
     /// See also <seealso cref="IntField"/>, <seealso cref="LongField"/>, {@link
-    /// FloatField}.
+    /// FloatField}.</p>
     ///
     /// <p>To perform range querying or filtering against a
     /// <code>DoubleField</code>, use <seealso cref="NumericRangeQuery"/>
or {@link
@@ -93,13 +94,13 @@ namespace Lucene.Net.Documents
     /// For low cardinality fields larger precision steps are good.
     /// If the cardinality is &lt; 100, it is fair
     /// to use <seealso cref="Integer#MAX_VALUE"/>, which produces one
-    /// term per value.
+    /// term per value.</p>
     ///
     /// <p>For more information on the internals of numeric trie
     /// indexing, including the <a
     /// href="../search/NumericRangeQuery.html#precisionStepDesc"><code>precisionStep</code></a>
     /// configuration, see <seealso cref="NumericRangeQuery"/>. The format of
-    /// indexed values is described in <seealso cref="NumericUtils"/>.
+    /// indexed values is described in <seealso cref="NumericUtils"/>.</p>
     ///
     /// <p>If you only need to sort by numeric value, and never
     /// run range querying/filtering, you can index using a
@@ -113,7 +114,6 @@ namespace Lucene.Net.Documents
     ///
     /// @since 2.9
     /// </summary>
-
     public sealed class DoubleField : Field
     {
         /// <summary>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/FloatDocValuesField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/FloatDocValuesField.cs b/src/Lucene.Net.Core/Document/FloatDocValuesField.cs
index 465c715..613d3e8 100644
--- a/src/Lucene.Net.Core/Document/FloatDocValuesField.cs
+++ b/src/Lucene.Net.Core/Document/FloatDocValuesField.cs
@@ -29,11 +29,11 @@ namespace Lucene.Net.Documents
     /// via <seealso cref="Float#floatToRawIntBits(float)"/>.
     /// <p>
     /// Per-document floating point values can be retrieved via
-    /// <seealso cref="IFieldCache#getFloats(AtomicReader, String, boolean)"/>.
+    /// <seealso cref="IFieldCache#getFloats(AtomicReader, String, boolean)"/>.</p>
     /// <p>
     /// <b>NOTE</b>: In most all cases this will be rather inefficient,
     /// requiring four bytes per document. Consider encoding floating
-    /// point values yourself with only as much precision as you require.
+    /// point values yourself with only as much precision as you require.</p>
     /// </summary>
     public class FloatDocValuesField : NumericDocValuesField
     {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/FloatField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/FloatField.cs b/src/Lucene.Net.Core/Document/FloatField.cs
index 8056a9b..f1713d9 100644
--- a/src/Lucene.Net.Core/Document/FloatField.cs
+++ b/src/Lucene.Net.Core/Document/FloatField.cs
@@ -2,6 +2,7 @@ using System;
 
 using Lucene.Net.Index;
 using Lucene.Net.Search;
+using Lucene.Net.Util;
 
 namespace Lucene.Net.Documents
 {
@@ -52,7 +53,7 @@ namespace Lucene.Net.Documents
     /// </pre>
     ///
     /// See also <seealso cref="IntField"/>, <seealso cref="LongField"/>, {@link
-    /// DoubleField}.
+    /// DoubleField}.</p>
     ///
     /// <p>To perform range querying or filtering against a
     /// <code>FloatField</code>, use <seealso cref="NumericRangeQuery"/>
or {@link
@@ -93,13 +94,13 @@ namespace Lucene.Net.Documents
     /// For low cardinality fields larger precision steps are good.
     /// If the cardinality is &lt; 100, it is fair
     /// to use <seealso cref="Integer#MAX_VALUE"/>, which produces one
-    /// term per value.
+    /// term per value.</p>
     ///
     /// <p>For more information on the internals of numeric trie
     /// indexing, including the <a
     /// href="../search/NumericRangeQuery.html#precisionStepDesc"><code>precisionStep</code></a>
     /// configuration, see <seealso cref="NumericRangeQuery"/>. The format of
-    /// indexed values is described in <seealso cref="NumericUtils"/>.
+    /// indexed values is described in <seealso cref="NumericUtils"/>.</p>
     ///
     /// <p>If you only need to sort by numeric value, and never
     /// run range querying/filtering, you can index using a
@@ -113,7 +114,6 @@ namespace Lucene.Net.Documents
     ///
     /// @since 2.9
     /// </summary>
-
     public sealed class FloatField : Field
     {
         /// <summary>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/IntDocValuesField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/IntDocValuesField.cs b/src/Lucene.Net.Core/Document/IntDocValuesField.cs
index dee8692..fd7842e 100644
--- a/src/Lucene.Net.Core/Document/IntDocValuesField.cs
+++ b/src/Lucene.Net.Core/Document/IntDocValuesField.cs
@@ -1,5 +1,7 @@
 
 
+using System;
+
 namespace Lucene.Net.Documents
 {
     /*
@@ -20,27 +22,24 @@ namespace Lucene.Net.Documents
      */
 
     /// <summary>
-    /// <p>
-    /// Field that stores a per-document <code>int</code> value for scoring,
+    ///  Field that stores a per-document <code>int</code> value for scoring,
     /// sorting or value retrieval. Here's an example usage:
     ///
     /// <pre class="prettyprint">
     ///   document.add(new IntDocValuesField(name, 22));
     /// </pre>
     ///
-    /// <p>
     /// If you also need to store the value, you should add a
     /// separate <seealso cref="StoredField"/> instance. </summary>
-    /// <seealso cref= NumericDocValues </seealso>
-    /// @deprecated use <seealso cref="NumericDocValuesField"/> instead.
-    ///
+    /// <seealso cref="NumericDocValuesField"/>
+    [Obsolete("Deprecated, use NumericDocValuesField instead")]
     public class IntDocValuesField : NumericDocValuesField
     {
         /// <summary>
         /// Creates a new DocValues field with the specified 32-bit integer value </summary>
         /// <param name="name"> field name </param>
         /// <param name="value"> 32-bit integer value </param>
-        /// <exception cref="IllegalArgumentException"> if the field name is null </exception>
+        /// <exception cref="ArgumentException"> if the field name is null </exception>
         public IntDocValuesField(string name, int value)
             : base(name, value)
         {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/IntField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/IntField.cs b/src/Lucene.Net.Core/Document/IntField.cs
index 6ad726e..22793cf 100644
--- a/src/Lucene.Net.Core/Document/IntField.cs
+++ b/src/Lucene.Net.Core/Document/IntField.cs
@@ -2,6 +2,7 @@ using System;
 
 using Lucene.Net.Index;
 using Lucene.Net.Search;
+using Lucene.Net.Util;
 
 namespace Lucene.Net.Documents
 {
@@ -51,7 +52,7 @@ namespace Lucene.Net.Documents
     /// </pre>
     ///
     /// See also <seealso cref="LongField"/>, <seealso cref="FloatField"/>, {@link
-    /// DoubleField}.
+    /// DoubleField}.</p>
     ///
     /// <p>To perform range querying or filtering against a
     /// <code>IntField</code>, use <seealso cref="NumericRangeQuery"/>
or {@link
@@ -92,13 +93,13 @@ namespace Lucene.Net.Documents
     /// For low cardinality fields larger precision steps are good.
     /// If the cardinality is &lt; 100, it is fair
     /// to use <seealso cref="Integer#MAX_VALUE"/>, which produces one
-    /// term per value.
+    /// term per value.</p>
     ///
     /// <p>For more information on the internals of numeric trie
     /// indexing, including the <a
     /// href="../search/NumericRangeQuery.html#precisionStepDesc"><code>precisionStep</code></a>
     /// configuration, see <seealso cref="NumericRangeQuery"/>. The format of
-    /// indexed values is described in <seealso cref="NumericUtils"/>.
+    /// indexed values is described in <seealso cref="NumericUtils"/>.</p>
     ///
     /// <p>If you only need to sort by numeric value, and never
     /// run range querying/filtering, you can index using a

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/LongDocValuesField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/LongDocValuesField.cs b/src/Lucene.Net.Core/Document/LongDocValuesField.cs
index d40ac74..fe3db75 100644
--- a/src/Lucene.Net.Core/Document/LongDocValuesField.cs
+++ b/src/Lucene.Net.Core/Document/LongDocValuesField.cs
@@ -1,4 +1,5 @@
 using System;
+using Lucene.Net.Index;
 
 
 namespace Lucene.Net.Documents
@@ -27,14 +28,14 @@ namespace Lucene.Net.Documents
     ///
     /// <pre class="prettyprint">
     ///   document.add(new LongDocValuesField(name, 22L));
-    /// </pre>
+    /// </pre></p>
     ///
     /// <p>
     /// If you also need to store the value, you should add a
-    /// separate <seealso cref="StoredField"/> instance. </summary>
-    /// <seealso cref= NumericDocValues </seealso>
-    /// @deprecated use <seealso cref="NumericDocValuesField"/> instead.
-    ///
+    /// separate <seealso cref="StoredField"/> instance.</p>
+    /// </summary>
+    /// <seealso cref="NumericDocValues"/>
+    [Obsolete("Use NumericDocValuesField instead")]
     public class LongDocValuesField : NumericDocValuesField
     {
         /// <summary>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/LongField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/LongField.cs b/src/Lucene.Net.Core/Document/LongField.cs
index 61a7cad..11a4843 100644
--- a/src/Lucene.Net.Core/Document/LongField.cs
+++ b/src/Lucene.Net.Core/Document/LongField.cs
@@ -1,5 +1,7 @@
 using System;
 using Lucene.Net.Index;
+using Lucene.Net.Search;
+using Lucene.Net.Util;
 
 namespace Lucene.Net.Documents
 {
@@ -50,11 +52,11 @@ namespace Lucene.Net.Documents
     ///
     /// Any type that can be converted to long can also be
     /// indexed.  For example, date/time values represented by a
-    /// <seealso cref="java.util.Date"/> can be translated into a long
-    /// value using the <seealso cref="java.util.Date#getTime"/> method.  If you
+    /// <seealso cref="Date"/> can be translated into a long
+    /// value using the <seealso cref="Date#getTime"/> method.  If you
     /// don't need millisecond precision, you can quantize the
     /// value, either by dividing the result of
-    /// <seealso cref="java.util.Date#getTime"/> or using the separate getters
+    /// <seealso cref="Date#getTime"/> or using the separate getters
     /// (for year, month, etc.) to construct an <code>int</code> or
     /// <code>long</code> value.</p>
     ///
@@ -97,13 +99,13 @@ namespace Lucene.Net.Documents
     /// For low cardinality fields larger precision steps are good.
     /// If the cardinality is &lt; 100, it is fair
     /// to use <seealso cref="Integer#MAX_VALUE"/>, which produces one
-    /// term per value.
+    /// term per value.</p>
     ///
     /// <p>For more information on the internals of numeric trie
     /// indexing, including the <a
     /// href="../search/NumericRangeQuery.html#precisionStepDesc"><code>precisionStep</code></a>
     /// configuration, see <seealso cref="NumericRangeQuery"/>. The format of
-    /// indexed values is described in <seealso cref="NumericUtils"/>.
+    /// indexed values is described in <seealso cref="NumericUtils"/>.</p>
     ///
     /// <p>If you only need to sort by numeric value, and never
     /// run range querying/filtering, you can index using a
@@ -117,7 +119,6 @@ namespace Lucene.Net.Documents
     ///
     /// @since 2.9
     /// </summary>
-
     public sealed class LongField : Field
     {
         /// <summary>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/NumericDocValuesField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/NumericDocValuesField.cs b/src/Lucene.Net.Core/Document/NumericDocValuesField.cs
index 2327654..2adbad0 100644
--- a/src/Lucene.Net.Core/Document/NumericDocValuesField.cs
+++ b/src/Lucene.Net.Core/Document/NumericDocValuesField.cs
@@ -21,7 +21,6 @@ namespace Lucene.Net.Documents
      * limitations under the License.
      */
     /// <summary>
-    /// <p>
     /// Field that stores a per-document <code>long</code> value for scoring,
     /// sorting or value retrieval. Here's an example usage:
     ///
@@ -29,12 +28,9 @@ namespace Lucene.Net.Documents
     ///   document.add(new NumericDocValuesField(name, 22L));
     /// </pre>
     ///
-    /// <p>
     /// If you also need to store the value, you should add a
     /// separate <seealso cref="StoredField"/> instance.
-    ///
     /// </summary>
-
     public class NumericDocValuesField : Field
     {
         /// <summary>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/SortedDocValuesField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/SortedDocValuesField.cs b/src/Lucene.Net.Core/Document/SortedDocValuesField.cs
index 9bf2af8..2bce9b2 100644
--- a/src/Lucene.Net.Core/Document/SortedDocValuesField.cs
+++ b/src/Lucene.Net.Core/Document/SortedDocValuesField.cs
@@ -29,13 +29,11 @@ namespace Lucene.Net.Documents
     ///
     /// <pre class="prettyprint">
     ///   document.add(new SortedDocValuesField(name, new BytesRef("hello")));
-    /// </pre>
+    /// </pre></p>
     ///
     /// <p>
     /// If you also need to store the value, you should add a
-    /// separate <seealso cref="StoredField"/> instance.
-    ///
-    ///
+    /// separate <seealso cref="StoredField"/> instance.</p>
     /// </summary>
     public class SortedDocValuesField : Field
     {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/StoredField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/StoredField.cs b/src/Lucene.Net.Core/Document/StoredField.cs
index c682d76..9dcfa61 100644
--- a/src/Lucene.Net.Core/Document/StoredField.cs
+++ b/src/Lucene.Net.Core/Document/StoredField.cs
@@ -1,3 +1,4 @@
+using System;
 using Lucene.Net.Index;
 using Lucene.Net.Util;
 
@@ -37,8 +38,7 @@ namespace Lucene.Net.Documents
 
         static StoredField()
         {
-            TYPE = new FieldType();
-            TYPE.Stored = true;
+            TYPE = new FieldType {Stored = true};
             TYPE.Freeze();
         }
 
@@ -48,7 +48,7 @@ namespace Lucene.Net.Documents
         /// not to change it until you're done with this field. </summary>
         /// <param name="name"> field name </param>
         /// <param name="value"> byte array pointing to binary content (not copied)
</param>
-        /// <exception cref="IllegalArgumentException"> if the field name is null.
</exception>
+        /// <exception cref="ArgumentException"> if the field name is null. </exception>
         public StoredField(string name, byte[] value)
             : base(name, value, TYPE)
         {
@@ -62,7 +62,7 @@ namespace Lucene.Net.Documents
         /// <param name="value"> byte array pointing to binary content (not copied)
</param>
         /// <param name="offset"> starting position of the byte array </param>
         /// <param name="length"> valid length of the byte array </param>
-        /// <exception cref="IllegalArgumentException"> if the field name is null.
</exception>
+        /// <exception cref="ArgumentException"> if the field name is null. </exception>
         public StoredField(string name, byte[] value, int offset, int length)
             : base(name, value, offset, length, TYPE)
         {
@@ -74,7 +74,7 @@ namespace Lucene.Net.Documents
         /// not to change it until you're done with this field. </summary>
         /// <param name="name"> field name </param>
         /// <param name="value"> BytesRef pointing to binary content (not copied) </param>
-        /// <exception cref="IllegalArgumentException"> if the field name is null.
</exception>
+        /// <exception cref="ArgumentException"> if the field name is null. </exception>
         public StoredField(string name, BytesRef value)
             : base(name, value, TYPE)
         {
@@ -84,7 +84,7 @@ namespace Lucene.Net.Documents
         /// Create a stored-only field with the given string value. </summary>
         /// <param name="name"> field name </param>
         /// <param name="value"> string value </param>
-        /// <exception cref="IllegalArgumentException"> if the field name or value
is null. </exception>
+        /// <exception cref="ArgumentException"> if the field name or value is null.
</exception>
         public StoredField(string name, string value)
             : base(name, value, TYPE)
         {
@@ -95,7 +95,7 @@ namespace Lucene.Net.Documents
         /// Create a stored-only field with the given integer value. </summary>
         /// <param name="name"> field name </param>
         /// <param name="value"> integer value </param>
-        /// <exception cref="IllegalArgumentException"> if the field name is null.
</exception>
+        /// <exception cref="ArgumentException"> if the field name is null. </exception>
         public StoredField(string name, int value)
             : base(name, TYPE)
         {
@@ -106,7 +106,7 @@ namespace Lucene.Net.Documents
         /// Create a stored-only field with the given float value. </summary>
         /// <param name="name"> field name </param>
         /// <param name="value"> float value </param>
-        /// <exception cref="IllegalArgumentException"> if the field name is null.
</exception>
+        /// <exception cref="ArgumentException"> if the field name is null. </exception>
         public StoredField(string name, float value)
             : base(name, TYPE)
         {
@@ -117,7 +117,7 @@ namespace Lucene.Net.Documents
         /// Create a stored-only field with the given long value. </summary>
         /// <param name="name"> field name </param>
         /// <param name="value"> long value </param>
-        /// <exception cref="IllegalArgumentException"> if the field name is null.
</exception>
+        /// <exception cref="ArgumentException"> if the field name is null. </exception>
         public StoredField(string name, long value)
             : base(name, TYPE)
         {
@@ -128,7 +128,7 @@ namespace Lucene.Net.Documents
         /// Create a stored-only field with the given double value. </summary>
         /// <param name="name"> field name </param>
         /// <param name="value"> double value </param>
-        /// <exception cref="IllegalArgumentException"> if the field name is null.
</exception>
+        /// <exception cref="ArgumentException"> if the field name is null. </exception>
         public StoredField(string name, double value)
             : base(name, TYPE)
         {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4db724fd/src/Lucene.Net.Core/Document/StringField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Core/Document/StringField.cs b/src/Lucene.Net.Core/Document/StringField.cs
index 2766a35..0464a36 100644
--- a/src/Lucene.Net.Core/Document/StringField.cs
+++ b/src/Lucene.Net.Core/Document/StringField.cs
@@ -1,3 +1,4 @@
+using System;
 using Lucene.Net.Index;
 
 namespace Lucene.Net.Documents
@@ -57,11 +58,12 @@ namespace Lucene.Net.Documents
         }
 
         /// <summary>
-        /// Creates a new StringField. </summary>
+        /// Creates a new StringField (a field that is indexed but not tokenized)
+        /// </summary>
         ///  <param name="name"> field name </param>
         ///  <param name="value"> String value </param>
         ///  <param name="stored"> Store.YES if the content should also be stored </param>
-        ///  <exception cref="IllegalArgumentException"> if the field name or value
is null. </exception>
+        ///  <exception cref="ArgumentException"> if the field name or value is null.
</exception>
         public StringField(string name, string value, Store stored)
             : base(name, value, stored == Store.YES ? TYPE_STORED : TYPE_NOT_STORED)
         {


Mime
View raw message