Skip to content

Commit

Permalink
fix see href links (#13138)
Browse files Browse the repository at this point in the history
  • Loading branch information
mairaw authored and prmathur-microsoft committed Jul 8, 2020
1 parent c84327a commit 7cc6878
Show file tree
Hide file tree
Showing 23 changed files with 64 additions and 64 deletions.
4 changes: 2 additions & 2 deletions sdk/iot/Azure.Iot.Hub.Service/src/IoTHubServiceClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ protected IoTHubServiceClient()
/// </summary>
/// <param name="connectionString">
/// The IoT Hub connection string, with either "iothubowner", "service", "registryRead" or "registryReadWrite" policy, as applicable.
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-security#access-control-and-permissions"/>.
/// For more information, see <see href="https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security#access-control-and-permissions">Access control and permissions</see>.
/// </param>
public IoTHubServiceClient(string connectionString)
: this(connectionString, new IoTHubServiceClientOptions())
Expand All @@ -75,7 +75,7 @@ public IoTHubServiceClient(string connectionString)
/// </summary>
/// <param name="connectionString">
/// The IoT Hub connection string, with either "iothubowner", "service", "registryRead" or "registryReadWrite" policy, as applicable.
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-security#access-control-and-permissions"/>.
/// For more information, see <see href="https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security#access-control-and-permissions">Access control and permissions</see>.
/// </param>
/// <param name="options">
/// Options that allow configuration of requests sent to the IoT Hub service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace Azure.Security.KeyVault.Keys
/// <summary>
/// A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data
/// structure that represents a cryptographic key.
/// For more information, see <see href="http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18"/>.
/// For more information, see <see href="http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18">JSON Web Key (JWK)</see>.
/// </summary>
public class JsonWebKey : IJsonDeserializable, IJsonSerializable
{
Expand Down
2 changes: 1 addition & 1 deletion sdk/search/Azure.Search.Documents/src/SearchFilter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ namespace Azure.Search.Documents
/// expressions, like the kind used by <see cref="SearchOptions.Filter"/>,
/// by automatically replacing, quoting, and escaping interpolated
/// parameters.
/// <see href="https://docs.microsoft.com/en-us/azure/search/search-filters"/>
/// For more information, see <see href="https://docs.microsoft.com/azure/search/search-filters">Filters in Azure Cognitive Search</see>.
/// </summary>
public static class SearchFilter
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ public BlobExtractionMode(string value)

/// <summary>
/// Specifies that only the standard blob properties and user-specified metadata will be indexed.
/// See <see href="https://docs.microsoft.com/azure/storage/storage-properties-metadata" /> for details.
/// See <see href="https://docs.microsoft.com/azure/storage/blobs/storage-blob-container-properties-metadata">Manage container properties and metadata with .NET</see> for details.
/// </summary>
public static BlobExtractionMode StorageMetadata { get; } = new BlobExtractionMode(StorageMetadataValue);

/// <summary>
/// Specifies that storage metadata and the content-type specific metadata extracted from the blob content will be indexed.
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#content-type-specific-metadata-properties" /> for details.
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#content-type-specific-metadata-properties">Content type-specific metadata properties</see> for details.
/// </summary>
public static BlobExtractionMode AllMetadata { get; } = new BlobExtractionMode(AllMetadataValue);

/// <summary>
/// Specifies that all metadata and textual content extracted from the blob will be indexed. This is the default value.
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#document-extraction-process"/> for details.
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage">How to index documents in Azure Blob Storage with Azure Cognitive Search</see> for details.
/// </summary>
public static BlobExtractionMode ContentAndMetadata { get; } = new BlobExtractionMode(ContentAndMetadataValue);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ public static IndexingParameters SetParseDelimitedTextFiles(this IndexingParamet

/// <summary>
/// Tells the indexer to assume that blobs should be parsed as text files in UTF-8 encoding.
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#indexing-plain-text"/> for details.
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#indexing-plain-text">Indexing plain text</see> for details.
/// </summary>
/// <param name="parameters">The <see cref="IndexingParameters"/> to configure.</param>
/// <returns>The <see cref="IndexingParameters"/> instance.</returns>
Expand All @@ -182,7 +182,7 @@ public static IndexingParameters SetParseText(this IndexingParameters parameters

/// <summary>
/// Tells the indexer to assume that blobs should be parsed as text files in the desired encoding.
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#indexing-plain-text"/> for details.
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#indexing-plain-text">Indexing plain text</see> for details.
/// </summary>
/// <param name="parameters">The <see cref="IndexingParameters"/> to configure.</param>
/// <param name="encoding">Encoding used to read the text stored in blobs.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ public struct BlobExtractionMode : IEquatable<BlobExtractionMode>

/// <summary>
/// Specifies that only the standard blob properties and user-specified metadata will be indexed.
/// <see href="https://docs.microsoft.com/azure/storage/storage-properties-metadata" />
/// For more information, see <see href="https://docs.microsoft.com/azure/storage/blobs/storage-blob-container-properties-metadata">Manage container properties and metadata with .NET</see>.
/// </summary>
public static readonly BlobExtractionMode StorageMetadata = new BlobExtractionMode("storageMetadata");

/// <summary>
/// Specifies that storage metadata and the content-type specific metadata extracted from the blob content will be indexed.
/// <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#content-type-specific-metadata-properties" />
/// For more information, see <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#content-type-specific-metadata-properties">Content type-specific metadata properties</see>.
/// </summary>
public static readonly BlobExtractionMode AllMetadata = new BlobExtractionMode("allMetadata");

/// <summary>
/// Specifies that all metadata and textual content extracted from the blob will be indexed. This is the default value.
/// <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#document-extraction-process"/>
/// For more information, see <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage">How to index documents in Azure Blob Storage with Azure Cognitive Search</see>.
/// </summary>
public static readonly BlobExtractionMode ContentAndMetadata = new BlobExtractionMode("contentAndMetadata");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public partial class FieldMappingFunction
/// characters and you want to use it to populate a key field in your search index, use this function.
/// </para>
/// <para>
/// For details on the encoding used, see <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings#details-of-base64-encoding-and-decoding"/>.
/// For details on the encoding used, see <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings">Field mappings and transformations using Azure Cognitive Search indexers</see>.
/// Calling this method is the same as calling <c cref="Base64Encode(bool)"/> with <c>useHttpServerUtilityUrlTokenEncode</c> set to <c>true</c>.
/// </para>
/// </remarks>
Expand All @@ -29,7 +29,7 @@ public partial class FieldMappingFunction
/// Creates a field mapping function that performs URL-safe Base64 encoding of the input string. Assumes that
/// the input is UTF-8 encoded.
/// </summary>
/// <param name="useHttpServerUtilityUrlTokenEncode">Determines how Base64 encoding is performed. See <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings#details-of-base64-encoding-and-decoding"/> for details.</param>
/// <param name="useHttpServerUtilityUrlTokenEncode">Determines how Base64 encoding is performed. See <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings">Field mappings and transformations using Azure Cognitive Search indexers</see> for details.</param>
/// <remarks>
/// Sample use case: Only URL-safe characters can appear in a search document key (because customers
/// must be able to address the document using the Lookup API, for example). If your data contains URL-unsafe
Expand Down Expand Up @@ -77,7 +77,7 @@ public static FieldMappingFunction Base64Encode(bool useHttpServerUtilityUrlToke
/// use this function to turn the encoded data back into "regular" strings when populating your search index.
/// </para>
/// <para>
/// For details on the decoding used, see <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings#details-of-base64-encoding-and-decoding"/>.
/// For details on the decoding used, see <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings">Field mappings and transformations using Azure Cognitive Search indexers</see>.
/// Calling this method is the same as calling <c cref="Base64Decode(bool)"/> with <c>useHttpServerUtilityUrlTokenDecode</c> set to <c>true</c>.
/// </para>
/// </remarks>
Expand All @@ -88,7 +88,7 @@ public static FieldMappingFunction Base64Encode(bool useHttpServerUtilityUrlToke
/// Creates a field mapping function that performs Base64 decoding of the input string. The input is assumed
/// to a URL-safe Base64-encoded string.
/// </summary>
/// <param name="useHttpServerUtilityUrlTokenDecode">Determines how Base64 decoding is performed. See <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings#details-of-base64-encoding-and-decoding"/> for details.</param>
/// <param name="useHttpServerUtilityUrlTokenDecode">Determines how Base64 decoding is performed. See <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings">Field mappings and transformations using Azure Cognitive Search indexers</see> for details.</param>
/// <remarks>
/// Sample use case: Blob custom metadata values must be ASCII-encoded. You can use Base64 encoding to
/// represent arbitrary Unicode strings in blob custom metadata. However, to make search meaningful, you can
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ public static IndexingParameters ParseDelimitedTextFiles(this IndexingParameters

/// <summary>
/// Tells the indexer to assume that blobs should be parsed as text files in UTF-8 encoding.
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#indexing-plain-text"/>
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#indexing-plain-text">Indexing plain text</see> for details.
/// </summary>
/// <param name="parameters">IndexingParameters to configure.</param>
/// <returns>The IndexingParameters instance.</returns>
Expand All @@ -173,7 +173,7 @@ public static IndexingParameters ParseText(this IndexingParameters parameters) =

/// <summary>
/// Tells the indexer to assume that blobs should be parsed as text files in the desired encoding.
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#indexing-plain-text"/>
/// See <see href="https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#indexing-plain-text">Indexing plain text</see> for details.
/// </summary>
/// <param name="parameters">IndexingParameters to configure.</param>
/// <param name="encoding">Encoding used to read the text stored in blobs.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ internal partial class IndexesOperations
{
/// <summary>
/// Creates a new search index or updates an index if it already exists.
/// <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Index" />
/// <see href="https://docs.microsoft.com/rest/api/searchservice/update-index">Update Index</see>
/// </summary>
/// <param name='index'>
/// The definition of the index to create or update.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ namespace Microsoft.Azure.Search

/// <summary>
/// Operations for managing indexes.
/// <see href="https://docs.microsoft.com/rest/api/searchservice/Index-operations" />
/// For more information, see <see href="https://docs.microsoft.com/rest/api/searchservice/index-operations">Index operations</see>.
/// </summary>
public static partial class IndexesOperationsExtensions
{
/// <summary>
/// Creates a new search index or updates an index if it already exists.
/// <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Index" />
/// For more information, see <see href="https://docs.microsoft.com/rest/api/searchservice/update-index">Update Index</see>.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
Expand Down Expand Up @@ -51,7 +51,7 @@ public static partial class IndexesOperationsExtensions

/// <summary>
/// Creates a new search index or updates an index if it already exists.
/// <see href="https://docs.microsoft.com/rest/api/searchservice/Update-Index" />
/// For more information, see <see href="https://docs.microsoft.com/rest/api/searchservice/update-index">Update Index</see>.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
Expand Down Expand Up @@ -143,7 +143,7 @@ public static async Task<bool> ExistsAsync(
/// service. Use this instead of List() when you only need index
/// names. It will save bandwidth and resource utilization, especially
/// if your Search Service has many indexes.
/// <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexes"/>
/// For more information, see <see href="https://docs.microsoft.com/rest/api/searchservice/list-indexes">List Indexes</see>.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
Expand All @@ -166,7 +166,7 @@ public static IList<string> ListNames(
/// service. Use this instead of List() when you only need index
/// names. It will save bandwidth and resource utilization, especially
/// if your Search Service has many indexes.
/// <see href="https://docs.microsoft.com/rest/api/searchservice/List-Indexes"/>
/// For more information, see <see href="https://docs.microsoft.com/rest/api/searchservice/list-indexes">List Indexes</see>.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Microsoft.Azure.Search.Models

/// <summary>
/// Defines the names of all character filters supported by Azure Cognitive Search.
/// <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search"/>
/// For more information, see <see href="https://docs.microsoft.com/azure/search/index-add-custom-analyzers">Add custom analyzers to string fields in an Azure Cognitive Search index</see>.
/// </summary>
[JsonConverter(typeof(ExtensibleEnumConverter<CharFilterName>))]
public struct CharFilterName : IEquatable<CharFilterName>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Microsoft.Azure.Search.Models

/// <summary>
/// Defines the names of all token filters supported by Azure Cognitive Search.
/// <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search"/>
/// For more information, see <see href="https://docs.microsoft.com/azure/search/index-add-custom-analyzers">Add custom analyzers to string fields in an Azure Cognitive Search index</see>.
/// </summary>
[JsonConverter(typeof(ExtensibleEnumConverter<TokenFilterName>))]
public struct TokenFilterName : IEquatable<TokenFilterName>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Microsoft.Azure.Search.Models

/// <summary>
/// Defines the names of all tokenizers supported by Azure Cognitive Search.
/// <see href="https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search"/>
/// For more information, see <see href="https://docs.microsoft.com/azure/search/index-add-custom-analyzers">Add custom analyzers to string fields in an Azure Cognitive Search index</see>.
/// </summary>
[JsonConverter(typeof(ExtensibleEnumConverter<TokenizerName>))]
public struct TokenizerName : IEquatable<TokenizerName>
Expand Down
Loading

0 comments on commit 7cc6878

Please sign in to comment.