Skip to content

Commit cf8e6f4

Browse files
paulirwinclaude
paulirwin
and
claude
committed
Fix docfx documentation warnings and broken cross-references
Reduces docfx build warnings from 645 to 24 (-96%) and resolves all UidNotFound cross-reference failures. Doc comment fixes: - Retarget <see cref> that pointed at private/internal members to the public property where one exists (LiveIndexWriterConfig.MergePolicy, NumericRangeQuery.PrecisionStep, Int64BitSet.Length, MaxCodeLen, MaxThreadCount), or <c> where no public equivalent exists. docfx does not emit pages for non-public members, so these anchors never resolved. - Correct stale ports: IndexOptions was de-nested from FieldInfo, Judge and QualityQueryParser became IJudge/IQualityQueryParser, and several .NET signatures take an extra CancellationToken. - Replace leftover javadoc syntax ({@docroot}, package-summary.html, ../core/*.html) with xref uids or plain code formatting. - Fix heading slugs and anchors that no longer matched generated ids, including a TOC that had been "fixed" by pasting in garbled slugs. - Formulas in NumericRangeQuery referenced doc-files/*.png that were never ported; render them as text and keep the LaTeX in a comment. Build configuration: - Add missing xrefmaps so cross-project uids resolve (core, icu, join, memory, site). - Add icu and memory to the intentional duplicates in docs.ps1; both have circular xrefmap dependencies, matching the existing codecs/core workaround. Known remaining: 24 warnings and 8 dead xref: links on 5 pages. These are cross-project uids in overwrite-only files, which no xref syntax resolves, plus 3 benign DuplicateUids where docfx merges correctly and an intentional OpenNLP security pin. Upstream docfx PR #11090 addresses the underlying cause: uids carry no assembly component, so assemblies sharing a namespace collapse onto one identity. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 2b0333f commit cf8e6f4

83 files changed

Lines changed: 222 additions & 224 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/Lucene.Net.Analysis.Common/Analysis/Compound/DictionaryCompoundWordTokenFilter.cs‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,7 @@ public class DictionaryCompoundWordTokenFilter : CompoundWordTokenFilterBase
4646
/// </summary>
4747
/// <param name="matchVersion">
4848
/// Lucene version to enable correct Unicode 4.0 behavior in the
49-
/// dictionaries if Version > 3.0. See <a
50-
/// href="CompoundWordTokenFilterBase.html#version"
51-
/// >CompoundWordTokenFilterBase</a> for details. </param>
49+
/// dictionaries if Version > 3.0. See <see cref="CompoundWordTokenFilterBase"/> for details. </param>
5250
/// <param name="input">
5351
/// the <see cref="TokenStream"/> to process </param>
5452
/// <param name="dictionary">
@@ -67,9 +65,7 @@ public DictionaryCompoundWordTokenFilter(LuceneVersion matchVersion, TokenStream
6765
/// </summary>
6866
/// <param name="matchVersion">
6967
/// Lucene version to enable correct Unicode 4.0 behavior in the
70-
/// dictionaries if Version > 3.0. See <a
71-
/// href="CompoundWordTokenFilterBase.html#version"
72-
/// >CompoundWordTokenFilterBase</a> for details. </param>
68+
/// dictionaries if Version > 3.0. See <see cref="CompoundWordTokenFilterBase"/> for details. </param>
7369
/// <param name="input">
7470
/// the <see cref="TokenStream"/> to process </param>
7571
/// <param name="dictionary">

‎src/Lucene.Net.Analysis.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,7 @@ public class HyphenationCompoundWordTokenFilter : CompoundWordTokenFilterBase
5050
/// </summary>
5151
/// <param name="matchVersion">
5252
/// Lucene version to enable correct Unicode 4.0 behavior in the
53-
/// dictionaries if Version > 3.0. See <a
54-
/// href="CompoundWordTokenFilterBase.html#version"
55-
/// >CompoundWordTokenFilterBase</a> for details. </param>
53+
/// dictionaries if Version > 3.0. See <see cref="CompoundWordTokenFilterBase"/> for details. </param>
5654
/// <param name="input">
5755
/// the <see cref="TokenStream"/> to process </param>
5856
/// <param name="hyphenator">
@@ -71,9 +69,7 @@ public HyphenationCompoundWordTokenFilter(LuceneVersion matchVersion, TokenStrea
7169
/// </summary>
7270
/// <param name="matchVersion">
7371
/// Lucene version to enable correct Unicode 4.0 behavior in the
74-
/// dictionaries if Version > 3.0. See <a
75-
/// href="CompoundWordTokenFilterBase.html#version"
76-
/// >CompoundWordTokenFilterBase</a> for details. </param>
72+
/// dictionaries if Version > 3.0. See <see cref="CompoundWordTokenFilterBase"/> for details. </param>
7773
/// <param name="input">
7874
/// the <see cref="TokenStream"/> to process </param>
7975
/// <param name="hyphenator">

‎src/Lucene.Net.Analysis.Common/Analysis/Core/TypeTokenFilter.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public TypeTokenFilter(LuceneVersion version, TokenStream input, ICollection<str
7676

7777
/// <summary>
7878
/// By default accept the token if its type is not a stop type.
79-
/// When the <see cref="useWhiteList"/> parameter is set to true then accept the token if its type is contained in the <see cref="stopTypes"/>
79+
/// When the <c>useWhiteList</c> parameter is set to true then accept the token if its type is contained in the <c>stopTypes</c>
8080
/// </summary>
8181
protected override bool Accept()
8282
{

‎src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/LimitTokenCountFilterFactory.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ namespace Lucene.Net.Analysis.Miscellaneous
3232
/// &lt;/analyzer&gt;
3333
/// &lt;/fieldType&gt;</code>
3434
/// <para>
35-
/// The <see cref="consumeAllTokens"/> property is optional and defaults to <c>false</c>.
35+
/// The <see cref="CONSUME_ALL_TOKENS_KEY"/> property is optional and defaults to <c>false</c>.
3636
/// See <see cref="LimitTokenCountFilter"/> for an explanation of it's use.
3737
/// </para>
3838
/// </summary>

‎src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/LimitTokenPositionFilterFactory.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ namespace Lucene.Net.Analysis.Miscellaneous
3232
/// &lt;/analyzer&gt;
3333
/// &lt;/fieldType&gt;</code>
3434
/// <para>
35-
/// The <see cref="consumeAllTokens"/> property is optional and defaults to <c>false</c>.
35+
/// The <see cref="CONSUME_ALL_TOKENS_KEY"/> property is optional and defaults to <c>false</c>.
3636
/// See <see cref="LimitTokenPositionFilter"/> for an explanation of its use.
3737
/// </para>
3838
/// </summary>

‎src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/StemmerOverrideFilter.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ public class Builder
166166
private readonly CharsRef charsSpare = new CharsRef();
167167

168168
/// <summary>
169-
/// Creates a new <see cref="Builder"/> with <see cref="ignoreCase"/> set to <c>false</c>
169+
/// Creates a new <see cref="Builder"/> with <c>ignoreCase</c> set to <c>false</c>
170170
/// </summary>
171171
public Builder()
172172
: this(false)

‎src/Lucene.Net.Analysis.Common/Analysis/Pattern/PatternCaptureGroupTokenFilter.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ namespace Lucene.Net.Analysis.Pattern
6262
/// </code>
6363
/// </para>
6464
/// <para>
65-
/// plus if <see cref="preserveOriginal"/> is true, it would also return
65+
/// plus if <c>preserveOriginal</c> is true, it would also return
6666
/// <c>camelCaseFilter</c>
6767
/// </para>
6868
/// </summary>

‎src/Lucene.Net.Analysis.Common/Analysis/Reverse/ReverseStringFilter.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ namespace Lucene.Net.Analysis.Reverse
2525
/// <summary>
2626
/// Reverse token string, for example "country" => "yrtnuoc".
2727
/// <para>
28-
/// If <see cref="marker"/> is supplied, then tokens will be also prepended by
28+
/// If <c>marker</c> is supplied, then tokens will be also prepended by
2929
/// that character. For example, with a marker of &#x5C;u0001, "country" =>
3030
/// "&#x5C;u0001yrtnuoc". This is useful when implementing efficient leading
3131
/// wildcards search.

‎src/Lucene.Net.Analysis.Common/Analysis/Util/BufferedCharFilter.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ private void EnsureOpen()
220220
/// Sets a mark position in this reader. The parameter <paramref name="markLimit"/>
221221
/// indicates how many characters can be read before the mark is invalidated.
222222
/// Calling <see cref="Reset()"/> will reposition the reader back to the marked
223-
/// position if <see cref="markLimit"/> has not been surpassed.
223+
/// position if <c>markLimit</c> has not been surpassed.
224224
/// </summary>
225225
/// <param name="markLimit">
226226
/// the number of characters that can be read before the mark is
@@ -555,7 +555,7 @@ public override void Reset()
555555
/// <summary>
556556
/// Skips <paramref name="amount"/> characters in this reader. Subsequent
557557
/// <see cref="Read()"/>s will not return these characters unless <see cref="Reset()"/>
558-
/// is used. Skipping characters may invalidate a mark if <see cref="markLimit"/>
558+
/// is used. Skipping characters may invalidate a mark if <c>markLimit</c>
559559
/// is surpassed.
560560
/// </summary>
561561
/// <param name="amount">the maximum number of characters to skip.</param>

‎src/Lucene.Net.Analysis.Common/Analysis/Util/CharArrayMap.cs‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1422,7 +1422,7 @@ private void SetImpl(char[] text, int startIndex, int length, MapValue value)
14221422

14231423
/// <summary>
14241424
/// This implementation enumerates over the specified <see cref="T:IDictionary{char[],TValue}"/>'s
1425-
/// entries, and calls this dictionary's <see cref="Set(char[], TValue?)"/> operation once for each entry.
1425+
/// entries, and calls this dictionary's <c>Set(char[], TValue)</c> operation once for each entry.
14261426
/// <para/>
14271427
/// If ignoreCase is <c>true</c> for this dictionary, the text arrays will be directly modified.
14281428
/// The user should never modify the text arrays after calling this method.
@@ -1448,7 +1448,7 @@ public virtual void PutAll(IDictionary<char[], TValue> collection)
14481448

14491449
/// <summary>
14501450
/// This implementation enumerates over the specified <see cref="T:IDictionary{string,TValue}"/>'s
1451-
/// entries, and calls this dictionary's <see cref="Set(string, TValue?)"/> operation once for each entry.
1451+
/// entries, and calls this dictionary's <c>Set(string, TValue)</c> operation once for each entry.
14521452
/// </summary>
14531453
/// <param name="collection">A dictionary of values to add/update in the current dictionary.</param>
14541454
/// <exception cref="ArgumentNullException">
@@ -1471,7 +1471,7 @@ public virtual void PutAll(IDictionary<string, TValue> collection)
14711471

14721472
/// <summary>
14731473
/// This implementation enumerates over the specified <see cref="T:IDictionary{ICharSequence,TValue}"/>'s
1474-
/// entries, and calls this dictionary's <see cref="Set(ICharSequence, TValue?)"/> operation once for each entry.
1474+
/// entries, and calls this dictionary's <c>Set(ICharSequence, TValue)</c> operation once for each entry.
14751475
/// </summary>
14761476
/// <param name="collection">A dictionary of values to add/update in the current dictionary.</param>
14771477
/// <exception cref="ArgumentNullException">
@@ -1498,7 +1498,7 @@ public virtual void PutAll(IDictionary<ICharSequence, TValue> collection)
14981498

14991499
/// <summary>
15001500
/// This implementation enumerates over the specified <see cref="T:IDictionary{T,TValue}"/>'s
1501-
/// entries, and calls this dictionary's <see cref="Set{T}(T, TValue?)"/> operation once for each entry.
1501+
/// entries, and calls this dictionary's <c>Set(T, TValue)</c> operation once for each entry.
15021502
/// </summary>
15031503
/// <param name="collection">A dictionary of values to add/update in the current dictionary.</param>
15041504
/// <exception cref="ArgumentNullException">
@@ -1521,7 +1521,7 @@ public virtual void PutAll<T>(IDictionary<T, TValue> collection)
15211521

15221522
/// <summary>
15231523
/// This implementation enumerates over the specified <see cref="T:IEnumerable{KeyValuePair{char[],TValue}}"/>'s
1524-
/// entries, and calls this dictionary's <see cref="Set(char[], TValue?)"/> operation once for each entry.
1524+
/// entries, and calls this dictionary's <c>Set(char[], TValue)</c> operation once for each entry.
15251525
/// </summary>
15261526
/// <param name="collection">The values to add/update in the current dictionary.</param>
15271527
/// <exception cref="ArgumentNullException">
@@ -1544,7 +1544,7 @@ public virtual void PutAll(IEnumerable<KeyValuePair<char[], TValue>> collection)
15441544

15451545
/// <summary>
15461546
/// This implementation enumerates over the specified <see cref="T:IEnumerable{KeyValuePair{string,TValue}}"/>'s
1547-
/// entries, and calls this dictionary's <see cref="Set(string, TValue)"/> operation once for each entry.
1547+
/// entries, and calls this dictionary's <c>Set(string, TValue)</c> operation once for each entry.
15481548
/// </summary>
15491549
/// <param name="collection">The values to add/update in the current dictionary.</param>
15501550
/// <exception cref="ArgumentNullException">
@@ -1567,7 +1567,7 @@ public virtual void PutAll(IEnumerable<KeyValuePair<string, TValue>> collection)
15671567

15681568
/// <summary>
15691569
/// This implementation enumerates over the specified <see cref="T:IEnumerable{KeyValuePair{ICharSequence,TValue}}"/>'s
1570-
/// entries, and calls this dictionary's <see cref="Set(ICharSequence, TValue)"/> operation once for each entry.
1570+
/// entries, and calls this dictionary's <c>Set(ICharSequence, TValue)</c> operation once for each entry.
15711571
/// </summary>
15721572
/// <param name="collection">The values to add/update in the current dictionary.</param>
15731573
/// <exception cref="ArgumentNullException">
@@ -1594,7 +1594,7 @@ public virtual void PutAll(IEnumerable<KeyValuePair<ICharSequence, TValue>> coll
15941594

15951595
/// <summary>
15961596
/// This implementation enumerates over the specified <see cref="T:IEnumerable{KeyValuePair{TKey,TValue}}"/>'s
1597-
/// entries, and calls this dictionary's <see cref="Set{T}(T, TValue?)"/> operation once for each entry.
1597+
/// entries, and calls this dictionary's <c>Set(T, TValue)</c> operation once for each entry.
15981598
/// </summary>
15991599
/// <param name="collection">The values to add/update in the current dictionary.</param>
16001600
/// <exception cref="ArgumentNullException">
@@ -2024,8 +2024,8 @@ public virtual CharArrayDictionary<TValue> ToCharArrayDictionary()
20242024
/// using the specified <paramref name="matchVersion"/> value. Preserves the value of <c>ignoreCase</c> from the current instance.
20252025
/// </summary>
20262026
/// <param name="matchVersion">
2027-
/// compatibility match version see <a href="#version">Version
2028-
/// note</a> above for details. </param>
2027+
/// compatibility match version see Version
2028+
/// note above for details. </param>
20292029
/// <returns> A copy of the current <see cref="CharArrayDictionary{TValue}"/> as a <see cref="CharArrayDictionary{TValue}"/>. </returns>
20302030
// LUCENENET specific - allow .NET-like syntax for copying CharArrayDictionary
20312031
public virtual CharArrayDictionary<TValue> ToCharArrayDictionary(LuceneVersion matchVersion)
@@ -2038,8 +2038,8 @@ public virtual CharArrayDictionary<TValue> ToCharArrayDictionary(LuceneVersion m
20382038
/// using the specified <paramref name="matchVersion"/> and <paramref name="ignoreCase"/> values.
20392039
/// </summary>
20402040
/// <param name="matchVersion">
2041-
/// compatibility match version see <a href="#version">Version
2042-
/// note</a> above for details. </param>
2041+
/// compatibility match version see Version
2042+
/// note above for details. </param>
20432043
/// <param name="ignoreCase"><c>false</c> if and only if the set should be case sensitive otherwise <c>true</c>.</param>
20442044
/// <returns> A copy of the current <see cref="CharArrayDictionary{TValue}"/> as a <see cref="CharArrayDictionary{TValue}"/>. </returns>
20452045
// LUCENENET specific - allow .NET-like syntax for copying CharArrayDictionary
@@ -3311,8 +3311,8 @@ public static class CharArrayDictionary // LUCENENET specific: CA1052 Static hol
33113311
/// </para>
33123312
/// </summary>
33133313
/// <param name="matchVersion">
3314-
/// compatibility match version see <a href="#version">Version
3315-
/// note</a> above for details. This argument will be ignored if the
3314+
/// compatibility match version see Version
3315+
/// note above for details. This argument will be ignored if the
33163316
/// given dictionary is a <see cref="CharArrayDictionary{TValue}"/>. </param>
33173317
/// <param name="dictionary">
33183318
/// a dictionary to copy </param>
@@ -3859,8 +3859,8 @@ public static class DictionaryExtensions
38593859
/// <param name="dictionary">
38603860
/// A <see cref="IDictionary{TKey, TValue}"/> to copy. </param>
38613861
/// <param name="matchVersion">
3862-
/// compatibility match version see <a href="#version">Version
3863-
/// note</a> above for details. </param>
3862+
/// compatibility match version see Version
3863+
/// note above for details. </param>
38643864
/// <returns> A copy of the current dictionary as a <see cref="CharArrayDictionary{TValue}"/>. </returns>
38653865
/// <exception cref="ArgumentNullException"><paramref name="dictionary"/> is <c>null</c>.</exception>
38663866
public static CharArrayDictionary<TValue> ToCharArrayDictionary<TValue>(this IDictionary<string, TValue> dictionary, LuceneVersion matchVersion)
@@ -3879,8 +3879,8 @@ public static CharArrayDictionary<TValue> ToCharArrayDictionary<TValue>(this IDi
38793879
/// <param name="dictionary">
38803880
/// A <see cref="IDictionary{TKey, TValue}"/> to copy. </param>
38813881
/// <param name="matchVersion">
3882-
/// compatibility match version see <a href="#version">Version
3883-
/// note</a> above for details. </param>
3882+
/// compatibility match version see Version
3883+
/// note above for details. </param>
38843884
/// <param name="ignoreCase"><c>false</c> if and only if the set should be case sensitive otherwise <c>true</c>.</param>
38853885
/// <returns> A copy of the current dictionary as a <see cref="CharArrayDictionary{TValue}"/>. </returns>
38863886
/// <exception cref="ArgumentNullException"><paramref name="dictionary"/> is <c>null</c>.</exception>

0 commit comments

Comments
 (0)