Skip to content

docs: fix errors with params documentation #3480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix errors with params documentation #3480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion iothub/device/src/Authentication/AuthenticationWithTokenRefresh.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public AuthenticationWithTokenRefresh(
/// may choose to ignore this value.</param>
/// <param name="timeBufferPercentage">Time buffer before expiry when the token should be renewed expressed as
/// a percentage of the time to live.</param>
/// <param name="disposeWithClient "><c>true</c> if the authentication method should be disposed of by the client
/// <param name="disposeWithClient"><c>true</c> if the authentication method should be disposed of by the client
/// when the client using this instance is itself disposed; <c>false</c> if you intend to reuse the authentication method.</param>
public AuthenticationWithTokenRefresh(
int suggestedTimeToLiveSeconds,
Expand Down
6 changes: 3 additions & 3 deletions iothub/device/src/Authentication/DeviceAuthenticationWithTokenRefresh.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ public DeviceAuthenticationWithTokenRefresh(
/// <param name="timeBufferPercentage">
/// The time buffer before expiry when the token should be renewed, expressed as a percentage of the time to live.
/// The default behavior is that the token will be renewed when it has 15% or less of its lifespan left.
///</param>
///<param name="disposeWithClient ">
///<c>true</c> if the authentication method should be disposed of by the client
/// </param>
/// <param name="disposeWithClient">
/// <c>true</c> if the authentication method should be disposed of by the client
/// when the client using this instance is itself disposed; <c>false</c> if you intend to reuse the authentication method.
/// </param>
public DeviceAuthenticationWithTokenRefresh(
Expand Down
2 changes: 1 addition & 1 deletion iothub/device/src/Authentication/DeviceAuthenticationWithTpm.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public DeviceAuthenticationWithTpm(
/// <param name="suggestedTimeToLiveSeconds">Token time to live suggested value.</param>
/// <param name="timeBufferPercentage">Time buffer before expiry when the token should be renewed expressed as percentage of
/// the time to live. EX: If you want a SAS token to live for 85% of life before proactive renewal, this value should be 15.</param>
/// <param name="disposeWithClient "><c>true</c> if the authentication method should be disposed of by the client
/// <param name="disposeWithClient"><c>true</c> if the authentication method should be disposed of by the client
/// when the client using this instance is itself disposed; <c>false</c> if you intend to reuse the authentication method.</param>
public DeviceAuthenticationWithTpm(
string deviceId,
Expand Down
6 changes: 3 additions & 3 deletions iothub/device/src/Authentication/ModuleAuthenticationWithTokenRefresh.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ public ModuleAuthenticationWithTokenRefresh(
/// <param name="timeBufferPercentage">
/// The time buffer before expiry when the token should be renewed, expressed as a percentage of the time to live.
/// The default behavior is that the token will be renewed when it has 15% or less of its lifespan left.
///</param>
///<param name="disposeWithClient ">
///<c>true</c> if the authentication method should be disposed of by the client
/// </param>
/// <param name="disposeWithClient">
/// <c>true</c> if the authentication method should be disposed of by the client
/// when the client using this instance is itself disposed; <c>false</c> if you intend to reuse the authentication method.
/// </param>
public ModuleAuthenticationWithTokenRefresh(
Expand Down