You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by la...@apache.org on 2023/04/09 04:20:12 UTC
[lucenenet] branch master updated: Add docs (#810)
This is an automated email from the ASF dual-hosted git repository.
laimis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
The following commit(s) were added to refs/heads/master by this push:
new 661277553 Add docs (#810)
661277553 is described below
commit 661277553560c2bb0eec24011bfad9b6a824e684
Author: Laimonas Simutis <la...@gmail.com>
AuthorDate: Sat Apr 8 21:20:07 2023 -0700
Add docs (#810)
---
src/Lucene.Net.Spatial/Prefix/Tree/Cell.cs | 8 +++++++-
src/Lucene.Net/Search/DisjunctionMaxQuery.cs | 8 +++++++-
src/Lucene.Net/Util/SentinelIntSet.cs | 7 +++++++
3 files changed, 21 insertions(+), 2 deletions(-)
diff --git a/src/Lucene.Net.Spatial/Prefix/Tree/Cell.cs b/src/Lucene.Net.Spatial/Prefix/Tree/Cell.cs
index 009d998a3..d34214438 100644
--- a/src/Lucene.Net.Spatial/Prefix/Tree/Cell.cs
+++ b/src/Lucene.Net.Spatial/Prefix/Tree/Cell.cs
@@ -177,7 +177,13 @@ namespace Lucene.Net.Spatial.Prefix.Tree
/// </remarks>
public virtual bool IsLeaf => m_leaf;
- /// <summary>Note: not supported at level 0.</summary>
+ /// <summary>Note: not supported at level 0.
+ ///
+ /// NOTE: When overriding this method, be aware that the constructor of this class calls
+ /// a private method and not this virtual method. So if you need to override
+ /// the behavior during the initialization, call your own private method from the constructor
+ /// with whatever custom behavior you need.
+ /// </summary>
public virtual void SetLeaf() => SetLeafInternal();
// LUCENENET specific - S1699 - private method that can be called
diff --git a/src/Lucene.Net/Search/DisjunctionMaxQuery.cs b/src/Lucene.Net/Search/DisjunctionMaxQuery.cs
index be7aeafd6..327492ff6 100644
--- a/src/Lucene.Net/Search/DisjunctionMaxQuery.cs
+++ b/src/Lucene.Net/Search/DisjunctionMaxQuery.cs
@@ -99,7 +99,13 @@ namespace Lucene.Net.Search
/// <summary>
/// Add a collection of disjuncts to this disjunction
- /// via <see cref="T:IEnumerable{Query}"/> </summary>
+ /// via <see cref="T:IEnumerable{Query}"/>
+ ///
+ /// NOTE: When overriding this method, be aware that the constructor of this class calls
+ /// a private method and not this virtual method. So if you need to override
+ /// the behavior during the initialization, call your own private method from the constructor
+ /// with whatever custom behavior you need.
+ /// </summary>
/// <param name="disjuncts"> A collection of queries to add as disjuncts. </param>
public virtual void Add(ICollection<Query> disjuncts) =>
AddInternal(disjuncts);
diff --git a/src/Lucene.Net/Util/SentinelIntSet.cs b/src/Lucene.Net/Util/SentinelIntSet.cs
index b8de0977a..350cfc632 100644
--- a/src/Lucene.Net/Util/SentinelIntSet.cs
+++ b/src/Lucene.Net/Util/SentinelIntSet.cs
@@ -93,6 +93,13 @@ namespace Lucene.Net.Util
}
}
+ /// <summary>
+ ///
+ /// NOTE: When overriding this method, be aware that the constructor of this class calls
+ /// a private method and not this virtual method. So if you need to override
+ /// the behavior during the initialization, call your own private method from the constructor
+ /// with whatever custom behavior you need.
+ /// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public virtual void Clear() => ClearInternal();
// LUCENENET specific - S1699 - non-virtual method that can be