Skip to content

Commit df95879

Browse files
authored
Update see links from summary blocks of code comments (Azure#17825)
* Used "Update synonym map" as text for see-link (from page H1) * Used "API versions in Azure Cognitive Search" as text for see-link (from page H1) * Used "Document operations" as text for see-link (from page H1) * Used "Count Documents" as text for see-link (from page H1) * Used "Update Data Source" as text for see-link (from page H1) * Used "Indexer operations" as text for see-link (from page H1) * Used "Create Indexer" as text for see-link (from page H1) * Used "How to index JSON blobs using a Blob indexer in Azure Cognitive Search" as text for see-link (from page H1) * Used "How to index CSV blobs using delimitedText parsing mode and Blob indexers in Azure Cognitive Search" as text for see-link (from page H1) * Used the H2 title without the "class" prefix and with the suffix "(Lucene API)" as text for see-links * Fixed documentation summer links for various `<see>` entries to include link text * Reverted changes to any files with _generated_ in the path * Reverted Microsoft.Azure.Search.* changes * Some docs still have invisible links, eg https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.search.documentsoperationsextensions * Re-trigger the CI test * Removed trailing white-space
1 parent d7832ad commit df95879

File tree

6 files changed

+20
-13
lines changed

6 files changed

+20
-13
lines changed

sdk/search/Azure.Search.Documents/src/Indexes/Models/LexicalAnalyzerName.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -186,17 +186,17 @@ public static class Values
186186
public const string ViMicrosoft = LexicalAnalyzerName.ViMicrosoftValue;
187187
/// <summary> Standard Lucene analyzer. </summary>
188188
public const string StandardLucene = LexicalAnalyzerName.StandardLuceneValue;
189-
/// <summary> Standard ASCII Folding Lucene analyzer. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers. </summary>
189+
/// <summary> Standard ASCII Folding Lucene analyzer. See <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers">Add custom analyzers to string fields in an Azure Cognitive Search index</see>. </summary>
190190
public const string StandardAsciiFoldingLucene = LexicalAnalyzerName.StandardAsciiFoldingLuceneValue;
191-
/// <summary> Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html. </summary>
191+
/// <summary> Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html">KeywordAnalyzer (Lucene API)</see>. </summary>
192192
public const string Keyword = LexicalAnalyzerName.KeywordValue;
193-
/// <summary> Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html. </summary>
193+
/// <summary> Flexibly separates text into terms via a regular expression pattern. See <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html">PatternAnalyzer (Lucene API)</see>. </summary>
194194
public const string Pattern = LexicalAnalyzerName.PatternValue;
195-
/// <summary> Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html. </summary>
195+
/// <summary> Divides text at non-letters and converts them to lower case. See <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html">SimpleAnalyzer (Lucene API)</see>. </summary>
196196
public const string Simple = LexicalAnalyzerName.SimpleValue;
197-
/// <summary> Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html. </summary>
197+
/// <summary> Divides text at non-letters; Applies the lowercase and stopword token filters. See <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html">StopAnalyzer (Lucene API)</see>. </summary>
198198
public const string Stop = LexicalAnalyzerName.StopValue;
199-
/// <summary> An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html. </summary>
199+
/// <summary> An analyzer that uses the whitespace tokenizer. See <see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html">WhitespaceAnalyzer (Lucene API)</see>. </summary>
200200
public const string Whitespace = LexicalAnalyzerName.WhitespaceValue;
201201
}
202202
#pragma warning restore CA1034 // Nested types should not be visible

sdk/search/Azure.Search.Documents/src/SearchClientOptions.cs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ public class SearchClientOptions : ClientOptions
2020
/// <summary>
2121
/// The versions of Azure Cognitive Search supported by this client
2222
/// library. For more, see
23-
/// <see href="https://docs.microsoft.com/azure/search/search-api-versions" />.
23+
/// <see href="https://docs.microsoft.com/azure/search/search-api-versions">
24+
/// API versions in Azure Cognitive Search</see>.
2425
/// </summary>
2526
public enum ServiceVersion
2627
{
@@ -48,7 +49,8 @@ public enum ServiceVersion
4849
/// <summary>
4950
/// Gets the <see cref="ServiceVersion"/> of the service API used when
5051
/// making requests. For more, see
51-
/// <see href="https://docs.microsoft.com/azure/search/search-api-versions" />.
52+
/// <see href="https://docs.microsoft.com/azure/search/search-api-versions">
53+
/// API versions in Azure Cognitive Search</see>.
5254
/// </summary>
5355
public ServiceVersion Version { get; }
5456

@@ -67,7 +69,8 @@ public enum ServiceVersion
6769
/// <param name="version">
6870
/// An optional <see cref="ServiceVersion"/> to specify the version of
6971
/// the REST API to use. For more, see
70-
/// <see href="https://docs.microsoft.com/azure/search/search-api-versions" />.
72+
/// <see href="https://docs.microsoft.com/azure/search/search-api-versions">
73+
/// API versions in Azure Cognitive Search</see>.
7174
///
7275
/// If not provided, the <paramref name="version"/> will default to the
7376
/// latest supported by this client library. It is recommended that

sdk/storage/Azure.Storage.Blobs/src/BlobClient.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,8 @@ internal BlobClient(
222222
/// class with an identical <see cref="Uri"/> source but the specified
223223
/// <paramref name="snapshot"/> timestamp.
224224
///
225-
/// For more information, see <see href="https://docs.microsoft.com/en-us/rest/api/storageservices/creating-a-snapshot-of-a-blob" />.
225+
/// For more information, see <see href="https://docs.microsoft.com/en-us/rest/api/storageservices/creating-a-snapshot-of-a-blob">
226+
/// Create a snapshot of a blob</see>.
226227
/// </summary>
227228
/// <param name="snapshot">The snapshot identifier.</param>
228229
/// <returns>A new <see cref="BlobClient"/> instance.</returns>

sdk/storage/Azure.Storage.Blobs/src/BlobLeaseClient.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,8 @@ private void EnsureClient()
145145
/// using the active lease ID as <see cref="LeaseId"/>, but you can
146146
/// specify a new <paramref name="duration"/>.
147147
///
148-
/// For more information, see <see href="https://docs.microsoft.com/rest/api/storageservices/lease-container" />.
148+
/// For more information, see <see href="https://docs.microsoft.com/rest/api/storageservices/lease-container">
149+
/// Lease Container</see>.
149150
/// </summary>
150151
/// <param name="duration">
151152
/// Specifies the duration of the lease, in seconds, or specify

sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeClientOptions.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ public enum ServiceVersion
6767
/// <summary>
6868
/// Gets the <see cref="ServiceVersion"/> of the service API used when
6969
/// making requests. For more, see
70-
/// <see href="https://docs.microsoft.com/en-us/rest/api/storageservices/versioning-for-the-azure-storage-services" />.
70+
/// <see href="https://docs.microsoft.com/en-us/rest/api/storageservices/versioning-for-the-azure-storage-services">
71+
/// Versioning for the Azure Storage services</see>.
7172
/// </summary>
7273
public ServiceVersion Version { get; }
7374

sdk/tables/Azure.Data.Tables/src/Sas/TableSasBuilder.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ namespace Azure.Data.Tables.Sas
1010
/// <summary>
1111
/// <see cref="TableSasBuilder"/> is used to generate a Shared Access
1212
/// Signature (SAS) for an Azure Storage table.
13-
/// For more information, see <see href="https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas" />.
13+
/// For more information, see <see href="https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas">
14+
/// Constructing an Account SAS</see>.
1415
/// </summary>
1516
public class TableSasBuilder
1617
{

0 commit comments

Comments
 (0)