Skip to content

Commit

Permalink
webdocs(adt): test seealso, and adding links for more resources (#12471)
Browse files Browse the repository at this point in the history
  • Loading branch information
David R. Williamson authored Jun 3, 2020
1 parent ed7c9cf commit 1dd4b47
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ public class DigitalTwinsClient
/// </summary>
/// <param name='endpoint'>The Azure digital twins service instance URI to connect to.</param>
/// <param name="credential">The <see cref="TokenCredential"/> implementation which will be used to request for the authentication token.</param>
/// <seealso cref="DigitalTwinsClient(Uri, TokenCredential)">
/// This other constructor provides an opportunity to override default behavior, including specifying API version,
/// overriding <see href="https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Pipeline.md">transport</see>,
/// enabling <see href="https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md">diagnostics</see>,
/// and controlling <see href="https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Configuration.md">retry strategy</see>.
/// </seealso>
/// <example>
/// <code snippet="Snippet:DigitalTwinsSampleCreateServiceClientWithClientSecret">
/// // By using the ClientSecretCredential, a specified application Id can login using a
Expand All @@ -53,11 +59,17 @@ public DigitalTwinsClient(Uri endpoint, TokenCredential credential)
}

/// <summary>
/// Creates a new instance of the <see cref="DigitalTwinsClient"/> class.
/// Creates a new instance of the <see cref="DigitalTwinsClient"/> class, with options.
/// </summary>
/// <param name='endpoint'>The Azure digital twins service instance URI to connect to.</param>
/// <param name="credential">The <see cref="TokenCredential"/> implementation which will be used to request for the authentication token.</param>
/// <param name="options"> Options that allow configuration of requests sent to the digital twins service.</param>
/// <param name="options">Options that allow configuration of requests sent to the digital twins service.</param>
/// <remarks>
/// The options parameter provides an opportunity to override default behavior, including specifying API version,
/// overriding <see href="https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Pipeline.md">transport</see>,
/// enabling <see href="https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md">diagnostics</see>,
/// and controlling <see href="https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Configuration.md">retry strategy</see>.
/// </remarks>
/// <example>
/// <code snippet="Snippet:DigitalTwinsSampleCreateServiceClientInteractiveLogin">
/// // This illustrates how to specify client options, in this case, by providing an
Expand Down Expand Up @@ -96,11 +108,11 @@ public DigitalTwinsClient(Uri endpoint, TokenCredential credential, DigitalTwins
}

/// <summary>
/// Creates a new instance of the <see cref="DigitalTwinsClient"/> class.
/// Creates a new instance of the <see cref="DigitalTwinsClient"/> class, provided for unit testing purposes only.
/// </summary>
protected DigitalTwinsClient()
{
// This constructor only exists for mocking purposes in unit tests. It should not be used otherwise
// This constructor only exists for mocking purposes in unit tests. It should not be used otherwise.
}

/// <summary>
Expand Down

0 comments on commit 1dd4b47

Please sign in to comment.