forked from Azure/azure-sdk-for-net
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Integrate InheritDoc into the build (Azure#17123)
# Summary Adds a reference to [InheritDoc](https://www.nuget.org/packages/SauceControl.InheritDoc/) to replace all `/// <inheritdoc/>` comments with the actual comment content in the documentation xml produced by the build. This is a development-only dependency; it will not be deployed with or referenced by the libraries. Note this produces a lot of warnings for `<inheritdoc />` comments that need to be further refined with a `cref="somBaseType"` attribute. Some examples of this are included in this PR. Example for `Azure.Security.KeyVault.Administration.xml`: **Before** ```xml <member name="P:Azure.Security.KeyVault.Administration.RestoreOperation.Id"> <inheritdoc/> </member> <member name="P:Azure.Security.KeyVault.Administration.RestoreOperation.Value"> <inheritdoc/> </member> <member name="P:Azure.Security.KeyVault.Administration.RestoreOperation.HasCompleted"> <inheritdoc/> </member> <member name="P:Azure.Security.KeyVault.Administration.RestoreOperation.HasValue"> <inheritdoc/> </member> <member name="M:Azure.Security.KeyVault.Administration.RestoreOperation.GetRawResponse"> <inheritdoc/> </member> ``` **After** ```xml <member name="P:Azure.Security.KeyVault.Administration.RestoreOperation.Id"> <summary> Gets an ID representing the operation that can be used to poll for the status of the long-running operation. </summary> </member> <member name="P:Azure.Security.KeyVault.Administration.RestoreOperation.Value"> <summary> Final result of the long-running operation. </summary><remarks> This property can be accessed only after the operation completes successfully (HasValue is true). </remarks> </member> <member name="P:Azure.Security.KeyVault.Administration.RestoreOperation.HasCompleted"> <summary> Returns true if the long-running operation completed. </summary> </member> <member name="P:Azure.Security.KeyVault.Administration.RestoreOperation.HasValue"> <summary> Returns true if the long-running operation completed successfully and has produced final result (accessible by Value property). </summary> </member> <member name="M:Azure.Security.KeyVault.Administration.RestoreOperation.GetRawResponse"> <summary> The last HTTP response received from the server. </summary><remarks> The last response returned from the server during the lifecycle of this instance. An instance of Operation<typeparamref name="T" /> sends requests to a server in UpdateStatusAsync, UpdateStatus, and other methods. Responses from these requests can be accessed using GetRawResponse. </remarks> </member> ```
- Loading branch information
1 parent
4063b2a
commit ecedc47
Showing
9 changed files
with
40 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters