You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2017/06/06 00:12:06 UTC
[33/48] lucenenet git commit: Lucene.Net.Codecs.PerField: Fixed XML
documentation warnings
Lucene.Net.Codecs.PerField: Fixed XML documentation warnings
Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/82141057
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/82141057
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/82141057
Branch: refs/heads/master
Commit: 8214105762280724576084f3177425cc86754fd3
Parents: a08ae94
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Mon Jun 5 05:31:16 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Tue Jun 6 06:58:39 2017 +0700
----------------------------------------------------------------------
CONTRIBUTING.md | 3 +-
.../Codecs/PerField/PerFieldDocValuesFormat.cs | 35 +++++++++++---------
.../Codecs/PerField/PerFieldPostingsFormat.cs | 35 +++++++++++---------
3 files changed, 39 insertions(+), 34 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/82141057/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index dafe5a8..21694de 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -58,8 +58,7 @@ helpers to help with that, see for examples see our [Java style methods to avoid
5. Codecs.Lucene42 (namespace)
6. Codecs.Lucene45 (namespace)
7. Codecs.Lucene46 (namespace)
- 8. Codecs.PerField (namespace)
- 9. Util.Packed (namespace)
+ 8. Util.Packed (namespace)
2. Lucene.Net.Codecs (project)
1. Appending (namespace)
2. BlockTerms (namespace)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/82141057/src/Lucene.Net/Codecs/PerField/PerFieldDocValuesFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/PerField/PerFieldDocValuesFormat.cs b/src/Lucene.Net/Codecs/PerField/PerFieldDocValuesFormat.cs
index daf7f84..45a0517 100644
--- a/src/Lucene.Net/Codecs/PerField/PerFieldDocValuesFormat.cs
+++ b/src/Lucene.Net/Codecs/PerField/PerFieldDocValuesFormat.cs
@@ -37,18 +37,21 @@ namespace Lucene.Net.Codecs.PerField
/// <summary>
/// Enables per field docvalues support.
- /// <p>
- /// Note, when extending this class, the name (<seealso cref="#getName"/>) is
+ /// <para/>
+ /// Note, when extending this class, the name (<see cref="DocValuesFormat.Name"/>) is
/// written into the index. In order for the field to be read, the
- /// name must resolve to your implementation via <seealso cref="#forName(String)"/>.
- /// this method uses Java's
- /// <seealso cref="ServiceLoader Service Provider Interface"/> to resolve format names.
- /// <p>
+ /// name must resolve to your implementation via <see cref="DocValuesFormat.ForName(string)"/>.
+ /// This method uses <see cref="IDocValuesFormatFactory.GetDocValuesFormat(string)"/> to resolve format names.
+ /// See <see cref="DefaultDocValuesFormatFactory"/> for information about how to implement your own <see cref="DocValuesFormat"/>.
+ /// <para/>
/// Files written by each docvalues format have an additional suffix containing the
- /// format name. For example, in a per-field configuration instead of <tt>_1.dat</tt>
- /// filenames would look like <tt>_1_Lucene40_0.dat</tt>. </summary>
- /// <seealso cref= ServiceLoader
- /// @lucene.experimental </seealso>
+ /// format name. For example, in a per-field configuration instead of <c>_1.dat</c>
+ /// filenames would look like <c>_1_Lucene40_0.dat</c>.
+ /// <para/>
+ /// @lucene.experimental
+ /// </summary>
+ /// <seealso cref="IDocValuesFormatFactory"/>
+ /// <seealso cref="DefaultDocValuesFormatFactory"/>
[DocValuesFormatName("PerFieldDV40")]
public abstract class PerFieldDocValuesFormat : DocValuesFormat
{
@@ -58,14 +61,14 @@ namespace Lucene.Net.Codecs.PerField
//public static readonly string PER_FIELD_NAME = "PerFieldDV40";
/// <summary>
- /// <seealso cref="FieldInfo"/> attribute name used to store the
- /// format name for each field.
+ /// <see cref="FieldInfo"/> attribute name used to store the
+ /// format name for each field.
/// </summary>
public static readonly string PER_FIELD_FORMAT_KEY = typeof(PerFieldDocValuesFormat).Name + ".format";
/// <summary>
- /// <seealso cref="FieldInfo"/> attribute name used to store the
- /// segment suffix name for each field.
+ /// <see cref="FieldInfo"/> attribute name used to store the
+ /// segment suffix name for each field.
/// </summary>
public static readonly string PER_FIELD_SUFFIX_KEY = typeof(PerFieldDocValuesFormat).Name + ".suffix";
@@ -395,8 +398,8 @@ namespace Lucene.Net.Codecs.PerField
/// <summary>
/// Returns the doc values format that should be used for writing
- /// new segments of <code>field</code>.
- /// <p>
+ /// new segments of <paramref name="field"/>.
+ /// <para/>
/// The field to format mapping is written to the index, so
/// this method is only invoked when writing, not when reading.
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/82141057/src/Lucene.Net/Codecs/PerField/PerFieldPostingsFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/PerField/PerFieldPostingsFormat.cs b/src/Lucene.Net/Codecs/PerField/PerFieldPostingsFormat.cs
index c214df8..66a0734 100644
--- a/src/Lucene.Net/Codecs/PerField/PerFieldPostingsFormat.cs
+++ b/src/Lucene.Net/Codecs/PerField/PerFieldPostingsFormat.cs
@@ -31,18 +31,21 @@ namespace Lucene.Net.Codecs.PerField
/// <summary>
/// Enables per field postings support.
- /// <p>
- /// Note, when extending this class, the name (<seealso cref="#getName"/>) is
+ /// <para/>
+ /// Note, when extending this class, the name (<see cref="PostingsFormat.Name"/>) is
/// written into the index. In order for the field to be read, the
- /// name must resolve to your implementation via <seealso cref="#forName(String)"/>.
- /// this method uses Java's
- /// <seealso cref="ServiceLoader Service Provider Interface"/> to resolve format names.
- /// <p>
+ /// name must resolve to your implementation via <see cref="PostingsFormat.ForName(string)"/>.
+ /// This method uses <see cref="IPostingsFormatFactory.GetPostingsFormat(string)"/> to resolve format names.
+ /// See <see cref="DefaultPostingsFormatFactory"/> for information about how to implement your own <see cref="PostingsFormat"/>.
+ /// <para/>
/// Files written by each posting format have an additional suffix containing the
- /// format name. For example, in a per-field configuration instead of <tt>_1.prx</tt>
- /// filenames would look like <tt>_1_Lucene40_0.prx</tt>. </summary>
- /// <seealso cref= ServiceLoader
- /// @lucene.experimental </seealso>
+ /// format name. For example, in a per-field configuration instead of <c>_1.prx</c>
+ /// filenames would look like <c>_1_Lucene40_0.prx</c>.
+ /// <para/>
+ /// @lucene.experimental
+ /// </summary>
+ /// <seealso cref="IPostingsFormatFactory"/>
+ /// <seealso cref="DefaultPostingsFormatFactory"/>
[PostingsFormatName("PerField40")] // LUCENENET specific - using PostingsFormatName attribute to ensure the default name passed from subclasses is the same as this class name
public abstract class PerFieldPostingsFormat : PostingsFormat
{
@@ -52,14 +55,14 @@ namespace Lucene.Net.Codecs.PerField
//public static readonly string PER_FIELD_NAME = "PerField40";
/// <summary>
- /// <seealso cref="FieldInfo"/> attribute name used to store the
- /// format name for each field.
+ /// <see cref="FieldInfo"/> attribute name used to store the
+ /// format name for each field.
/// </summary>
public static readonly string PER_FIELD_FORMAT_KEY = typeof(PerFieldPostingsFormat).Name + ".format";
/// <summary>
- /// <seealso cref="FieldInfo"/> attribute name used to store the
- /// segment suffix name for each field.
+ /// <see cref="FieldInfo"/> attribute name used to store the
+ /// segment suffix name for each field.
/// </summary>
public static readonly string PER_FIELD_SUFFIX_KEY = typeof(PerFieldPostingsFormat).Name + ".suffix";
@@ -292,8 +295,8 @@ namespace Lucene.Net.Codecs.PerField
/// <summary>
/// Returns the postings format that should be used for writing
- /// new segments of <code>field</code>.
- /// <p>
+ /// new segments of <paramref name="field"/>.
+ /// <para/>
/// The field to format mapping is written to the index, so
/// this method is only invoked when writing, not when reading.
/// </summary>