Skip to content

Commit 3940241

Browse files
gewarrengewarren
authored
fix up msbuild api ref (#4655)
1 parent f4ee6f8 commit 3940241

File tree

4 files changed

+75
-98
lines changed

4 files changed

+75
-98
lines changed

‎xml/Microsoft.Build.Framework/SdkResolver.xml

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>
18-
An abstract interface for classes that can resolve a Software Development Kit (SDK).
19-
</summary>
17+
<summary>An abstract interface for classes that can resolve a Software Development Kit (SDK).</summary>
2018
<remarks>To be added.</remarks>
2119
</Docs>
2220
<Members>
@@ -53,9 +51,7 @@
5351
<ReturnType>System.String</ReturnType>
5452
</ReturnValue>
5553
<Docs>
56-
<summary>
57-
Name of the SDK resolver to be displayed in build output log.
58-
</summary>
54+
<summary>Gets the name of the SDK resolver to be displayed in build output log.</summary>
5955
<value>To be added.</value>
6056
<remarks>To be added.</remarks>
6157
</Docs>
@@ -76,10 +72,8 @@
7672
<ReturnType>System.Int32</ReturnType>
7773
</ReturnValue>
7874
<Docs>
79-
<summary>
80-
Gets the self-described resolution priority order. MSBuild will sort resolvers
81-
by this value.
82-
</summary>
75+
<summary>Gets the self-described resolution priority order. MSBuild will sort resolvers
76+
by this value.</summary>
8377
<value>To be added.</value>
8478
<remarks>To be added.</remarks>
8579
</Docs>
@@ -107,18 +101,22 @@
107101
<Docs>
108102
<param name="sdkReference">A <see cref="T:Microsoft.Build.Framework.SdkReference" /> containing the referenced SDKs be resolved.</param>
109103
<param name="resolverContext">Context for resolving the SDK.</param>
110-
<param name="factory">Factory class to create an <see cref="T:Microsoft.Build.Framework.SdkResult" /></param>
111-
<summary>
112-
Resolves the specified SDK reference.
113-
</summary>
114-
<returns>
115-
An <see cref="T:Microsoft.Build.Framework.SdkResult" /> containing the resolved SDKs or associated error / reason
116-
the SDK could not be resolved. Return <c>null</c> if the resolver is not
117-
applicable for a particular <see cref="T:Microsoft.Build.Framework.SdkReference" />.
118-
<remarks>
119-
Note: You must use the <see cref="T:Microsoft.Build.Framework.SdkResultFactory" /> to return a result.
120-
</remarks></returns>
121-
<remarks>To be added.</remarks>
104+
<param name="factory">Factory class to create an <see cref="T:Microsoft.Build.Framework.SdkResult" />.</param>
105+
<summary>Resolves the specified SDK reference.</summary>
106+
<returns>The resolved SDKs or associated error or reason
107+
the SDK could not be resolved. Return <c>null</c> if the resolver is not
108+
applicable for a particular <see cref="T:Microsoft.Build.Framework.SdkReference" />.
109+
</returns>
110+
<remarks>
111+
<format type="text/markdown"><![CDATA[
112+
113+
## Remarks
114+
115+
> [!NOTE]
116+
> You must use the <see cref="T:Microsoft.Build.Framework.SdkResultFactory" /> to return a result.
117+
118+
]]></format>
119+
</remarks>
122120
</Docs>
123121
</Member>
124122
</Members>

‎xml/Microsoft.Build.Framework/SdkResolverContext.xml

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>
18-
Context used by an <see cref="T:Microsoft.Build.Framework.SdkResolver" /> to resolve an SDK.
19-
</summary>
17+
<summary>A context used by an <see cref="T:Microsoft.Build.Framework.SdkResolver" /> to resolve an SDK.</summary>
2018
<remarks>To be added.</remarks>
2119
</Docs>
2220
<Members>
@@ -53,9 +51,7 @@
5351
<ReturnType>System.Boolean</ReturnType>
5452
</ReturnValue>
5553
<Docs>
56-
<summary>
57-
Gets a value indicating if the resolver is allowed to be interactive.
58-
</summary>
54+
<summary>Gets a value indicating if the resolver is allowed to be interactive.</summary>
5955
<value>To be added.</value>
6056
<remarks>To be added.</remarks>
6157
</Docs>
@@ -76,9 +72,7 @@
7672
<ReturnType>Microsoft.Build.Framework.SdkLogger</ReturnType>
7773
</ReturnValue>
7874
<Docs>
79-
<summary>
80-
Logger to log real-time messages back to MSBuild.
81-
</summary>
75+
<summary>Gets a logger to log real-time messages back to MSBuild.</summary>
8276
<value>To be added.</value>
8377
<remarks>To be added.</remarks>
8478
</Docs>
@@ -99,14 +93,17 @@
9993
<ReturnType>System.Version</ReturnType>
10094
</ReturnValue>
10195
<Docs>
102-
<summary>
103-
Version of MSBuild currently running.
104-
<remarks>
105-
File version based on commit height from our public git repository. This is informational
106-
and not equal to the assembly version.
107-
</remarks></summary>
96+
<summary>Gets the version of MSBuild that's currently running.</summary>
10897
<value>To be added.</value>
109-
<remarks>To be added.</remarks>
98+
<remarks>
99+
<format type="text/markdown"><![CDATA[
100+
101+
## Remarks
102+
103+
File version is based on commit height from our public git repository. This is informational and not equal to the assembly version.
104+
105+
]]></format>
106+
</remarks>
110107
</Docs>
111108
</Member>
112109
<Member MemberName="ProjectFilePath">
@@ -125,9 +122,7 @@
125122
<ReturnType>System.String</ReturnType>
126123
</ReturnValue>
127124
<Docs>
128-
<summary>
129-
Path to the project file being built.
130-
</summary>
125+
<summary>Gets the path to the project file being built.</summary>
131126
<value>To be added.</value>
132127
<remarks>To be added.</remarks>
133128
</Docs>
@@ -148,9 +143,7 @@
148143
<ReturnType>System.String</ReturnType>
149144
</ReturnValue>
150145
<Docs>
151-
<summary>
152-
Path to the solution file being built, if known. May be null.
153-
</summary>
146+
<summary>Gets the path to the solution file being built, if known. May be null.</summary>
154147
<value>To be added.</value>
155148
<remarks>To be added.</remarks>
156149
</Docs>
@@ -171,10 +164,7 @@
171164
<ReturnType>System.Object</ReturnType>
172165
</ReturnValue>
173166
<Docs>
174-
<summary>
175-
Gets or sets any custom state for current build. This allows resolvers to maintain state between resolutions.
176-
This property is not thread-safe.
177-
</summary>
167+
<summary>Gets or sets any custom state for current build. This allows resolvers to maintain state between resolutions. This property is not thread-safe.</summary>
178168
<value>To be added.</value>
179169
<remarks>To be added.</remarks>
180170
</Docs>

‎xml/Microsoft.Build.Framework/SdkResult.xml

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,17 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>
18-
An abstract interface class to indicate SDK resolver success or failure.
19-
<remarks>
20-
Note: Use <see cref="T:Microsoft.Build.Framework.SdkResultFactory" /> to create instances of this class. Do not
21-
inherit from this class.
22-
</remarks></summary>
23-
<remarks>To be added.</remarks>
17+
<summary>An abstract interface class to indicate SDK resolver success or failure.</summary>
18+
<remarks>
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
23+
> [!NOTE]
24+
> Use <see cref="T:Microsoft.Build.Framework.SdkResultFactory" /> to create instances of this class. Do not inherit from this class.
25+
26+
]]></format>
27+
</remarks>
2428
</Docs>
2529
<Members>
2630
<Member MemberName=".ctor">
@@ -56,12 +60,8 @@
5660
<ReturnType>System.String</ReturnType>
5761
</ReturnValue>
5862
<Docs>
59-
<summary>
60-
Resolved path to the SDK.
61-
62-
Null if <see cref="P:Microsoft.Build.Framework.SdkResult.Success" /> == false
63-
</summary>
64-
<value>To be added.</value>
63+
<summary>Gets the resolved path to the SDK.</summary>
64+
<value>The resolved path to the SDK. <see langword="null" /> if <see cref="P:Microsoft.Build.Framework.SdkResult.Success" /> is <see langword="false" />.</value>
6565
<remarks>To be added.</remarks>
6666
</Docs>
6767
</Member>
@@ -81,10 +81,8 @@
8181
<ReturnType>Microsoft.Build.Framework.SdkReference</ReturnType>
8282
</ReturnValue>
8383
<Docs>
84-
<summary>
85-
The Sdk reference
86-
</summary>
87-
<value>To be added.</value>
84+
<summary>Gets the SDK reference.</summary>
85+
<value>The SDK reference.</value>
8886
<remarks>To be added.</remarks>
8987
</Docs>
9088
</Member>
@@ -104,10 +102,8 @@
104102
<ReturnType>System.Boolean</ReturnType>
105103
</ReturnValue>
106104
<Docs>
107-
<summary>
108-
Indicates the resolution was successful.
109-
</summary>
110-
<value>To be added.</value>
105+
<summary>Gets a value that indicates whether the resolution was successful.</summary>
106+
<value><see langword="true" /> if the resolution was successful; otherwise, <see langword="false" />.</value>
111107
<remarks>To be added.</remarks>
112108
</Docs>
113109
</Member>
@@ -127,13 +123,9 @@
127123
<ReturnType>System.String</ReturnType>
128124
</ReturnValue>
129125
<Docs>
130-
<summary>
131-
Resolved version of the SDK.
132-
Can be null or empty if the resolver did not provide a version (e.g. a path based resolver)
133-
134-
Null if <see cref="P:Microsoft.Build.Framework.SdkResult.Success" /> == false
135-
</summary>
136-
<value>To be added.</value>
126+
<summary>Gets the resolved version of the SDK.
127+
Can be <see langword="null" /> or empty if the resolver did not provide a version, for example, a path-based resolver.</summary>
128+
<value>The resolved version of the SDK. <see langword="null" /> if <see cref="P:Microsoft.Build.Framework.SdkResult.Success" /> is <see langword="false" />.</value>
137129
<remarks>To be added.</remarks>
138130
</Docs>
139131
</Member>

‎xml/Microsoft.Build.Tasks/Hash.xml

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,18 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>
18-
Generates a hash of a given ItemGroup items. Metadata is not considered in the hash.
19-
<remarks>
20-
Currently uses SHA1. Implementation subject to change between MSBuild versions. Not
21-
intended as a cryptographic security measure, only uniqueness between build executions.
22-
</remarks></summary>
23-
<remarks>To be added.</remarks>
17+
<summary> Generates a hash of a given group of items. Metadata is not considered in the hash.</summary>
18+
<remarks>
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
23+
Currently uses SHA1. The implementation is subject to change between MSBuild versions.
24+
25+
This class is not intended as a cryptographic security measure, only for uniqueness between build executions.
26+
27+
]]></format>
28+
</remarks>
2429
</Docs>
2530
<Members>
2631
<Member MemberName=".ctor">
@@ -57,9 +62,7 @@
5762
</ReturnValue>
5863
<Parameters />
5964
<Docs>
60-
<summary>
61-
Execute the task.
62-
</summary>
65+
<summary>Executes the task.</summary>
6366
<returns>To be added.</returns>
6467
<remarks>To be added.</remarks>
6568
</Docs>
@@ -86,10 +89,8 @@
8689
<ReturnType>System.String</ReturnType>
8790
</ReturnValue>
8891
<Docs>
89-
<summary>
90-
Hash of the ItemsToHash ItemSpec.
91-
</summary>
92-
<value>To be added.</value>
92+
<summary>Gets or sets the hash of the <see langword="ItemsToHash ItemSpec" />.</summary>
93+
<value>The hash of the <see langword="ItemsToHash ItemSpec" />.</value>
9394
<remarks>To be added.</remarks>
9495
</Docs>
9596
</Member>
@@ -109,10 +110,8 @@
109110
<ReturnType>System.Boolean</ReturnType>
110111
</ReturnValue>
111112
<Docs>
112-
<summary>
113-
When true, will generate a case-insensitive hash.
114-
</summary>
115-
<value>To be added.</value>
113+
<summary>Gets or sets a value that indicates whether to generate a case-insensitive hash.</summary>
114+
<value><see langword="true" /> to generate a case-insensitive hash; otherwise, <see langword="false" />.</value>
116115
<remarks>To be added.</remarks>
117116
</Docs>
118117
</Member>
@@ -138,10 +137,8 @@
138137
<ReturnType>Microsoft.Build.Framework.ITaskItem[]</ReturnType>
139138
</ReturnValue>
140139
<Docs>
141-
<summary>
142-
Items from which to generate a hash.
143-
</summary>
144-
<value>To be added.</value>
140+
<summary>Gets or sets the items from which to generate a hash.</summary>
141+
<value>The items from which to generate a hash.</value>
145142
<remarks>To be added.</remarks>
146143
</Docs>
147144
</Member>

0 commit comments

Comments
 (0)