diff options
| author | Joel Martinez <joelmartinez@gmail.com> | 2014-04-28 04:41:26 +0400 |
|---|---|---|
| committer | Joel Martinez <joelmartinez@gmail.com> | 2014-04-28 05:33:01 +0400 |
| commit | 6999270099fb530945023095063828765e1eb1c7 (patch) | |
| tree | 83cf08ef6dee957c5ebf3a35e2df7797ceec4c55 /mcs/class/Microsoft.Build.Framework | |
| parent | 7c67e309d8c555c6ca39472d62980874ff0e5ea4 (diff) | |
[docs] Import of Microsoft BCL Documentation.
The documentation is creative commons licensed.
Diffstat (limited to 'mcs/class/Microsoft.Build.Framework')
43 files changed, 1181 insertions, 359 deletions
diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/AnyEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/AnyEventHandler.xml index c30cd2d3e36..628e5778104 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/AnyEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/AnyEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="AnyEventHandler" FullName="Microsoft.Build.Framework.AnyEventHandler"> <TypeSignature Language="C#" Value="public delegate void AnyEventHandler(object sender, BuildEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.AnyEventRaised" /> event of a build.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildErrorEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildErrorEventArgs.xml index 7143f68dd20..3535efbb2a6 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildErrorEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildErrorEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildErrorEventArgs" FullName="Microsoft.Build.Framework.BuildErrorEventArgs"> <TypeSignature Language="C#" Value="public class BuildErrorEventArgs : Microsoft.Build.Framework.BuildEventArgs" /> <AssemblyInfo> @@ -9,9 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>WARNING: marking a type [Serializable] without implementing ISerializable imposes a serialization contract -- it is a promise to never change the type's fields i.e. the type is immutable; adding new fields in the next version of the type without following certain special FX guidelines, can break both forward and backward compatibility</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.ErrorRaised" /> event.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +26,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildErrorEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -43,19 +53,32 @@ <Parameter Name="senderName" Type="System.String" /> </Parameters> <Docs> - <param name="subcategory">To be added.</param> - <param name="code">To be added.</param> - <param name="file">To be added.</param> - <param name="lineNumber">To be added.</param> - <param name="columnNumber">To be added.</param> - <param name="endLineNumber">To be added.</param> - <param name="endColumnNumber">To be added.</param> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="senderName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildErrorEventArgs" /> class with the specified <see cref="P:Microsoft.Build.Framework.BuildErrorEventArgs.SubCategory" />, <see cref="P:Microsoft.Build.Framework.BuildErrorEventArgs.Code" />, <see cref="P:Microsoft.Build.Framework.BuildErrorEventArgs.File" />, <see cref="P:Microsoft.Build.Framework.BuildErrorEventArgs.LineNumber" />, <see cref="P:Microsoft.Build.Framework.BuildErrorEventArgs.ColumnNumber" />, <see cref="P:Microsoft.Build.Framework.BuildErrorEventArgs.EndLineNumber" />, <see cref="P:Microsoft.Build.Framework.BuildErrorEventArgs.EndColumnNumber" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.Message" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword" />, and <see cref="P:Microsoft.Build.Framework.BuildEventArgs.SenderName" /> values.</para> + </summary> + <param name="subcategory"> + <attribution license="cc4" from="Microsoft" modified="false" />The custom subcategory of the event.</param> + <param name="code"> + <attribution license="cc4" from="Microsoft" modified="false" />The error code of the event.</param> + <param name="file"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the file associated with the event.</param> + <param name="lineNumber"> + <attribution license="cc4" from="Microsoft" modified="false" />The line number that corresponds to the beginning of the section of code that raised the event.</param> + <param name="columnNumber"> + <attribution license="cc4" from="Microsoft" modified="false" />The column number that corresponds to the beginning of the section of code that raised the event.</param> + <param name="endLineNumber"> + <attribution license="cc4" from="Microsoft" modified="false" />The line number that corresponds to the end of the section of code that raised the event.</param> + <param name="endColumnNumber"> + <attribution license="cc4" from="Microsoft" modified="false" />The column number that corresponds to the end of the section of code that raised the event.</param> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="senderName"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -68,10 +91,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the error code of the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -84,10 +110,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the column number that corresponds to the beginning of the section of code that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -100,10 +129,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the column number that corresponds to the end of the section of code that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -116,10 +148,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the line number that corresponds to the end of the section of code that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -132,10 +167,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the file that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -148,10 +186,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the line number that corresponds to the beginning of the section of code that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -164,14 +205,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the custom subtype of the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildErrorEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildErrorEventHandler.xml index 9be264a1600..6bb8aecf14e 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildErrorEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildErrorEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildErrorEventHandler" FullName="Microsoft.Build.Framework.BuildErrorEventHandler"> <TypeSignature Language="C#" Value="public delegate void BuildErrorEventHandler(object sender, BuildErrorEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.ErrorRaised" /> event of a build.</para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildEventArgs.xml index 49b78cd62ca..c77034d0652 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildEventArgs" FullName="Microsoft.Build.Framework.BuildEventArgs"> <TypeSignature Language="C#" Value="public abstract class BuildEventArgs : EventArgs" /> <AssemblyInfo> @@ -9,9 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:Microsoft.Build.Framework.BuildEventArgs" /> class is an abstract base class for all <see cref="N:Microsoft.Build.Framework" /> event argument classes.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.AnyEventRaised" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +26,15 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This implementation of the <see cref="T:Microsoft.Build.Framework.BuildEventArgs" /> constructor takes no parameters, and sets the <see cref="P:Microsoft.Build.Framework.BuildEventArgs.TimeStamp" /> property to <see cref="P:System.DateTime.Now" /> and the <see cref="P:Microsoft.Build.Framework.BuildEventArgs.ThreadId" /> property to the current thread.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -36,12 +49,18 @@ <Parameter Name="senderName" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="senderName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildEventArgs" /> class with the specified <see cref="P:Microsoft.Build.Framework.BuildEventArgs.Message" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword" />, and <see cref="P:Microsoft.Build.Framework.BuildEventArgs.SenderName" /> values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="senderName"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -54,10 +73,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the Help keyword for the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -70,10 +92,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the message for the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -86,10 +111,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the <see cref="T:System.Object" /> raising the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -102,10 +130,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets an integer identifier for the thread that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -118,14 +149,17 @@ <ReturnType>System.DateTime</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the time the event was raised as a <see cref="T:System.DateTime" />.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildFinishedEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildFinishedEventArgs.xml index 1db38ea147a..95c1b419024 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildFinishedEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildFinishedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildFinishedEventArgs" FullName="Microsoft.Build.Framework.BuildFinishedEventArgs"> <TypeSignature Language="C#" Value="public class BuildFinishedEventArgs : Microsoft.Build.Framework.BuildStatusEventArgs" /> <AssemblyInfo> @@ -9,9 +10,12 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.BuildFinished" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +23,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildFinishedEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -36,12 +43,18 @@ <Parameter Name="succeeded" Type="System.Boolean" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="succeeded">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildFinishedEventArgs" /> class with the specified <see cref="P:Microsoft.Build.Framework.BuildEventArgs.Message" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword" />, and <see cref="P:Microsoft.Build.Framework.BuildFinishedEventArgs.Succeeded" /> values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="succeeded"> + <attribution license="cc4" from="Microsoft" modified="false" />true to indicate the build succeeded; otherwise, false.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -54,14 +67,17 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets a value indicating whether the build succeeded.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildFinishedEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildFinishedEventHandler.xml index f1287f99389..236ff819d9a 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildFinishedEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildFinishedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildFinishedEventHandler" FullName="Microsoft.Build.Framework.BuildFinishedEventHandler"> <TypeSignature Language="C#" Value="public delegate void BuildFinishedEventHandler(object sender, BuildFinishedEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.BuildFinished" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildMessageEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildMessageEventArgs.xml index 882120219ea..deb812e0f0d 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildMessageEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildMessageEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildMessageEventArgs" FullName="Microsoft.Build.Framework.BuildMessageEventArgs"> <TypeSignature Language="C#" Value="public class BuildMessageEventArgs : Microsoft.Build.Framework.BuildEventArgs" /> <AssemblyInfo> @@ -9,9 +10,12 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.MessageRaised" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +23,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildMessageEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -37,13 +44,20 @@ <Parameter Name="importance" Type="Microsoft.Build.Framework.MessageImportance" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="senderName">To be added.</param> - <param name="importance">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildMessageEventArgs" /> class with the specified <see cref="P:Microsoft.Build.Framework.BuildEventArgs.Message" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.SenderName" />, and <see cref="P:Microsoft.Build.Framework.BuildMessageEventArgs.Importance" /> values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="senderName"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param> + <param name="importance"> + <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:Microsoft.Build.Framework.MessageImportance" /> value indicating the importance of the event.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -56,14 +70,17 @@ <ReturnType>Microsoft.Build.Framework.MessageImportance</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the importance of the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildMessageEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildMessageEventHandler.xml index 3dcc307fbb1..c316cb8ef67 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildMessageEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildMessageEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildMessageEventHandler" FullName="Microsoft.Build.Framework.BuildMessageEventHandler"> <TypeSignature Language="C#" Value="public delegate void BuildMessageEventHandler(object sender, BuildMessageEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.MessageRaised" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStartedEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStartedEventArgs.xml index 9c47fffbf32..a5f1d1a66b7 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStartedEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStartedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildStartedEventArgs" FullName="Microsoft.Build.Framework.BuildStartedEventArgs"> <TypeSignature Language="C#" Value="public class BuildStartedEventArgs : Microsoft.Build.Framework.BuildStatusEventArgs" /> <AssemblyInfo> @@ -9,9 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>WARNING: marking a type [Serializable] without implementing ISerializable imposes a serialization contract -- it is a promise to never change the type's fields i.e. the type is immutable; adding new fields in the next version of the type without following certain special FX guidelines, can break both forward and backward compatibility</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.BuildStarted" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +26,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildStartedEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -35,15 +45,20 @@ <Parameter Name="helpKeyword" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildStartedEventArgs" /> class with the specified message and Help keyword.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStartedEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStartedEventHandler.xml index c7b469b38e1..86cc79e8bd0 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStartedEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStartedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildStartedEventHandler" FullName="Microsoft.Build.Framework.BuildStartedEventHandler"> <TypeSignature Language="C#" Value="public delegate void BuildStartedEventHandler(object sender, BuildStartedEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.BuildStarted" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStatusEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStatusEventArgs.xml index da8a3efb964..49f1f8e3778 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStatusEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStatusEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildStatusEventArgs" FullName="Microsoft.Build.Framework.BuildStatusEventArgs"> <TypeSignature Language="C#" Value="public abstract class BuildStatusEventArgs : Microsoft.Build.Framework.BuildEventArgs" /> <AssemblyInfo> @@ -9,9 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <see cref="T:Microsoft.Build.Framework.BuildStatusEventArgs" /> class is an abstract base class for all <see cref="N:Microsoft.Build.Framework" /> status event argument classes.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.StatusEventRaised" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +26,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildStatusEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -36,16 +46,22 @@ <Parameter Name="senderName" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="senderName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildStatusEventArgs" /> class with the specified <see cref="P:Microsoft.Build.Framework.BuildEventArgs.Message" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword" />, and <see cref="P:Microsoft.Build.Framework.BuildEventArgs.SenderName" /> values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="senderName"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStatusEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStatusEventHandler.xml index 9e7e3ca311b..efbbc9dabe3 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStatusEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildStatusEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildStatusEventHandler" FullName="Microsoft.Build.Framework.BuildStatusEventHandler"> <TypeSignature Language="C#" Value="public delegate void BuildStatusEventHandler(object sender, BuildStatusEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.StatusEventRaised" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildWarningEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildWarningEventArgs.xml index 193a5fd686f..eccd0bd6e2c 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildWarningEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildWarningEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildWarningEventArgs" FullName="Microsoft.Build.Framework.BuildWarningEventArgs"> <TypeSignature Language="C#" Value="public class BuildWarningEventArgs : Microsoft.Build.Framework.BuildEventArgs" /> <AssemblyInfo> @@ -9,9 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>WARNING: marking a type [Serializable] without implementing ISerializable imposes a serialization contract -- it is a promise to never change the type's fields i.e. the type is immutable; adding new fields in the next version of the type without following certain special FX guidelines, can break both forward and backward compatibility</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.WarningRaised" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +26,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildWarningEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -43,19 +53,32 @@ <Parameter Name="senderName" Type="System.String" /> </Parameters> <Docs> - <param name="subcategory">To be added.</param> - <param name="code">To be added.</param> - <param name="file">To be added.</param> - <param name="lineNumber">To be added.</param> - <param name="columnNumber">To be added.</param> - <param name="endLineNumber">To be added.</param> - <param name="endColumnNumber">To be added.</param> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="senderName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.BuildWarningEventArgs" /> class with the specified <see cref="P:Microsoft.Build.Framework.BuildWarningEventArgs.SubCategory" />, <see cref="P:Microsoft.Build.Framework.BuildWarningEventArgs.Code" />, <see cref="P:Microsoft.Build.Framework.BuildWarningEventArgs.File" />, <see cref="P:Microsoft.Build.Framework.BuildWarningEventArgs.LineNumber" />, <see cref="P:Microsoft.Build.Framework.BuildWarningEventArgs.ColumnNumber" />, <see cref="P:Microsoft.Build.Framework.BuildWarningEventArgs.EndLineNumber" />, <see cref="P:Microsoft.Build.Framework.BuildWarningEventArgs.EndColumnNumber" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.Message" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword" />, and <see cref="P:Microsoft.Build.Framework.BuildEventArgs.SenderName" /> values.</para> + </summary> + <param name="subcategory"> + <attribution license="cc4" from="Microsoft" modified="false" />The custom subcategory of the event.</param> + <param name="code"> + <attribution license="cc4" from="Microsoft" modified="false" />The warning code of the event.</param> + <param name="file"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the file associated with the event.</param> + <param name="lineNumber"> + <attribution license="cc4" from="Microsoft" modified="false" />The line number that corresponds to the beginning of the section of code that raised the event.</param> + <param name="columnNumber"> + <attribution license="cc4" from="Microsoft" modified="false" />The column number that corresponds to the beginning of the section of code that raised the event.</param> + <param name="endLineNumber"> + <attribution license="cc4" from="Microsoft" modified="false" />The line number that corresponds to the end of the section of code that raised the event.</param> + <param name="endColumnNumber"> + <attribution license="cc4" from="Microsoft" modified="false" />The column number that corresponds to the end of the section of code that raised the event.</param> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="senderName"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -68,10 +91,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the warning code of the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -84,10 +110,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the column number that corresponds to the beginning of the section of code that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -100,10 +129,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the column number that corresponds to the end of the section of code that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -116,10 +148,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the line number that corresponds to the end of the section of code that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -132,10 +167,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the file that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -148,10 +186,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the line number that corresponds to the beginning of the section of code that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -164,14 +205,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the custom subcategory of the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildWarningEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildWarningEventHandler.xml index 56f3a72614e..a06c5e435d3 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildWarningEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/BuildWarningEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="BuildWarningEventHandler" FullName="Microsoft.Build.Framework.BuildWarningEventHandler"> <TypeSignature Language="C#" Value="public delegate void BuildWarningEventHandler(object sender, BuildWarningEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.WarningRaised" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/CustomBuildEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/CustomBuildEventArgs.xml index 243c6bd01fe..7a102d211f4 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/CustomBuildEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/CustomBuildEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CustomBuildEventArgs" FullName="Microsoft.Build.Framework.CustomBuildEventArgs"> <TypeSignature Language="C#" Value="public abstract class CustomBuildEventArgs : Microsoft.Build.Framework.BuildEventArgs" /> <AssemblyInfo> @@ -9,9 +10,12 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.CustomEventRaised" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +23,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.CustomBuildEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -36,16 +43,22 @@ <Parameter Name="senderName" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="senderName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.CustomBuildEventArgs" /> class with the specified <see cref="P:Microsoft.Build.Framework.BuildEventArgs.Message" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword" />, and <see cref="P:Microsoft.Build.Framework.BuildEventArgs.SenderName" /> values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="senderName"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/CustomBuildEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/CustomBuildEventHandler.xml index b12a6f2f6c1..35c350ed16a 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/CustomBuildEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/CustomBuildEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="CustomBuildEventHandler" FullName="Microsoft.Build.Framework.CustomBuildEventHandler"> <TypeSignature Language="C#" Value="public delegate void CustomBuildEventHandler(object sender, CustomBuildEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.CustomEventRaised" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ExternalProjectFinishedEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ExternalProjectFinishedEventArgs.xml index a482a647cb2..3ea459a6257 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ExternalProjectFinishedEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ExternalProjectFinishedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ExternalProjectFinishedEventArgs" FullName="Microsoft.Build.Framework.ExternalProjectFinishedEventArgs"> <TypeSignature Language="C#" Value="public class ExternalProjectFinishedEventArgs : Microsoft.Build.Framework.CustomBuildEventArgs" /> <AssemblyInfo> @@ -9,9 +10,12 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.CustomEventRaised" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +23,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -38,14 +45,22 @@ <Parameter Name="succeeded" Type="System.Boolean" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="senderName">To be added.</param> - <param name="projectFile">To be added.</param> - <param name="succeeded">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs" /> class, with the specified values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="senderName"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param> + <param name="projectFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The project file name.</param> + <param name="succeeded"> + <attribution license="cc4" from="Microsoft" modified="false" />true to indicate that the project built successfully; otherwise false.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -58,10 +73,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the project file name that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -74,14 +92,17 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the build succeeded.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ExternalProjectStartedEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ExternalProjectStartedEventArgs.xml index d32e96fd49c..b6fcb3c0851 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ExternalProjectStartedEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ExternalProjectStartedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ExternalProjectStartedEventArgs" FullName="Microsoft.Build.Framework.ExternalProjectStartedEventArgs"> <TypeSignature Language="C#" Value="public class ExternalProjectStartedEventArgs : Microsoft.Build.Framework.CustomBuildEventArgs" /> <AssemblyInfo> @@ -9,9 +10,12 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.CustomEventRaised" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +23,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.ExternalProjectStartedEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -38,14 +45,22 @@ <Parameter Name="targetNames" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="senderName">To be added.</param> - <param name="projectFile">To be added.</param> - <param name="targetNames">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.ExternalProjectFinishedEventArgs" /> class, with the specified values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="senderName"> + <attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param> + <param name="projectFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The project file name.</param> + <param name="targetNames"> + <attribution license="cc4" from="Microsoft" modified="false" />The names of the targets to build in the external project. This can be a null reference (Nothing in vbprvb) if the external project is being built with the default targets.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -58,10 +73,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the project file that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -74,14 +92,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the target names that are being built in the project.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/IBuildEngine.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/IBuildEngine.xml index d98544ebd1a..631f9a0ab1c 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/IBuildEngine.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/IBuildEngine.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IBuildEngine" FullName="Microsoft.Build.Framework.IBuildEngine"> <TypeSignature Language="C#" Value="public interface IBuildEngine" /> <AssemblyInfo> @@ -6,9 +7,12 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides a way for task authors to use a subset of the functionality of the vstecmsbuild engine. </para> + </summary> </Docs> <Members> <Member MemberName="BuildProjectFile"> @@ -24,14 +28,26 @@ <Parameter Name="targetOutputs" Type="System.Collections.IDictionary" /> </Parameters> <Docs> - <param name="projectFileName">To be added.</param> - <param name="targetNames">To be added.</param> - <param name="globalProperties">To be added.</param> - <param name="targetOutputs">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The <paramref name="targetNames" />, <paramref name="globalProperties" />, and <paramref name="targetOutputs" /> parameters can be null.</para> + <para>If no targets are specified, vstecmsbuild builds the default targets of the project.</para> + <para>Target outputs are returned as <see cref="T:Microsoft.Build.Framework.ITaskItem" /> arrays indexed by target name.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initiates a build of a project file. If the build is successful, the outputs, if any, of the specified targets are returned.</para> + </summary> + <param name="projectFileName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the project file to build.</param> + <param name="targetNames"> + <attribution license="cc4" from="Microsoft" modified="false" />The names of the target in the project to build. Separate multiple targets with a semicolon (;).</param> + <param name="globalProperties"> + <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IDictionary" /> of additional global properties to apply to the project. The key and value must be String data types.</param> + <param name="targetOutputs"> + <attribution license="cc4" from="Microsoft" modified="false" />The outputs of each specified target.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -44,10 +60,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the line number of the task node within the project file that called it.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -60,10 +79,13 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Returns true if the ContinueOnError flag was set to true for this particular task in the project file.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -76,10 +98,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the line number of the task node within the project file that called it.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -95,10 +120,14 @@ <Parameter Name="e" Type="Microsoft.Build.Framework.CustomBuildEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises a custom event to all registered loggers.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The event data.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -114,10 +143,14 @@ <Parameter Name="e" Type="Microsoft.Build.Framework.BuildErrorEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises an error event to all registered loggers.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The event data.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -133,10 +166,14 @@ <Parameter Name="e" Type="Microsoft.Build.Framework.BuildMessageEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises a message event to all registered loggers.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The event data.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -152,10 +189,14 @@ <Parameter Name="e" Type="Microsoft.Build.Framework.BuildWarningEventArgs" /> </Parameters> <Docs> - <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Raises a warning event to all registered loggers.</para> + </summary> + <param name="e"> + <attribution license="cc4" from="Microsoft" modified="false" />The event data.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -168,14 +209,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the full path to the project file that contained the call to this task.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/IEventSource.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/IEventSource.xml index 4b8192e15ff..56e9b6b0cc5 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/IEventSource.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/IEventSource.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="IEventSource" FullName="Microsoft.Build.Framework.IEventSource"> <TypeSignature Language="C#" Value="public interface IEventSource" /> <AssemblyInfo> @@ -6,9 +7,12 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines the events raised by the build engine. Loggers receive an object implementing this interface in their <see cref="M:Microsoft.Build.Framework.ILogger.Initialize(Microsoft.Build.Framework.IEventSource)" /> method and use it to subscribe to the events they are interested in receiving.</para> + </summary> </Docs> <Members> <Member MemberName="AnyEventRaised"> @@ -18,9 +22,12 @@ <ReturnType>Microsoft.Build.Framework.AnyEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a build raises any other type of build event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -33,9 +40,12 @@ <ReturnType>Microsoft.Build.Framework.BuildFinishedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a build finishes.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -48,9 +58,12 @@ <ReturnType>Microsoft.Build.Framework.BuildStartedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a build starts.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -63,9 +76,12 @@ <ReturnType>Microsoft.Build.Framework.CustomBuildEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a build raises a custom event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -78,9 +94,12 @@ <ReturnType>Microsoft.Build.Framework.BuildErrorEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a build raises an error.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -93,9 +112,12 @@ <ReturnType>Microsoft.Build.Framework.BuildMessageEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a build raises a message.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -108,9 +130,12 @@ <ReturnType>Microsoft.Build.Framework.ProjectFinishedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a project finishes building.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -123,9 +148,12 @@ <ReturnType>Microsoft.Build.Framework.ProjectStartedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a project starts building.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -138,9 +166,12 @@ <ReturnType>Microsoft.Build.Framework.BuildStatusEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a build raises a status event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -153,9 +184,12 @@ <ReturnType>Microsoft.Build.Framework.TargetFinishedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a target finishes building.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -168,9 +202,12 @@ <ReturnType>Microsoft.Build.Framework.TargetStartedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a target starts building.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -183,9 +220,12 @@ <ReturnType>Microsoft.Build.Framework.TaskFinishedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a task completes execution.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -198,9 +238,12 @@ <ReturnType>Microsoft.Build.Framework.TaskStartedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a task begins execution.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -213,13 +256,16 @@ <ReturnType>Microsoft.Build.Framework.BuildWarningEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Occurs when a build raises a warning.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ILogger.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ILogger.xml index 147c205bf9d..99d52e7a4e0 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ILogger.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ILogger.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ILogger" FullName="Microsoft.Build.Framework.ILogger"> <TypeSignature Language="C#" Value="public interface ILogger" /> <AssemblyInfo> @@ -11,9 +12,16 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>All logger classes must implement this interface to be recognized by the vstecmsbuild engine.</para> + <para>Instead of implementing this interface directly, you can also derive your class from the helper class, <see cref="T:Microsoft.Build.Utilities.Logger" />, which provides default implementations of some <see cref="T:Microsoft.Build.Framework.ILogger" /> members.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines an vstecmsbuild logger, which subscribes to build system events.</para> + </summary> </Docs> <Members> <Member MemberName="Initialize"> @@ -26,10 +34,14 @@ <Parameter Name="eventSource" Type="Microsoft.Build.Framework.IEventSource" /> </Parameters> <Docs> - <param name="eventSource">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Subscribes loggers to specific events. This method is called when the logger is registered with the build engine, before any events are raised.</para> + </summary> + <param name="eventSource"> + <attribution license="cc4" from="Microsoft" modified="false" />The events available to loggers.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -42,10 +54,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Parameters may be represented in this property in any format. For example, to represent two parameters and values, you could use the string "parameter1=value1;parameter2=value2".</para> + <para>This property can be a null reference (Nothing in vbprvb).</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the user-defined parameters of the logger. </para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -59,9 +78,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Releases the resources allocated to the logger at the time of initialization or during the build. This method is called when the logger is unregistered from the engine, after all events are raised. A host of vstecmsbuild typically unregisters loggers immediately before quitting.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -74,14 +96,20 @@ <ReturnType>Microsoft.Build.Framework.LoggerVerbosity</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>While a logger is free to choose the events it logs, following the verbosity guidelines creates a consistent user experience.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the level of detail to show in the event log.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITask.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITask.xml index c47c77b1b46..e6fba6226ea 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITask.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITask.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ITask" FullName="Microsoft.Build.Framework.ITask"> <TypeSignature Language="C#" Value="public interface ITask" /> <AssemblyInfo> @@ -6,9 +7,15 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>All task classes must implement this interface to be recognized by the build engine. Instead of implenting this interface directly, you can also derive your class from the helper class, <see cref="T:Microsoft.Build.Utilities.Task" />, which provides default implementations of some <see cref="T:Microsoft.Build.Framework.ITask" /> members.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines a task, which is a unit of executable code used by vstecmsbuild to perform build operations.</para> + </summary> </Docs> <Members> <Member MemberName="BuildEngine"> @@ -18,10 +25,13 @@ <ReturnType>Microsoft.Build.Framework.IBuildEngine</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the build engine associated with the task.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -35,10 +45,16 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This method is called by the build engine to execute a task. Upon termination of this method, a task should indicate if the execution was successful. If a task throws an exception from this method, the engine assumes that the task has failed.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Executes a task.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -51,14 +67,20 @@ <ReturnType>Microsoft.Build.Framework.ITaskHost</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This property can be a null reference (Nothing in vbprvb).</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets any host object that is associated with the task.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITaskHost.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITaskHost.xml index 019392ad16b..9da2c86a284 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITaskHost.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITaskHost.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ITaskHost" FullName="Microsoft.Build.Framework.ITaskHost"> <TypeSignature Language="C#" Value="public interface ITaskHost" /> <AssemblyInfo> @@ -17,9 +18,16 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Empty interface.</para> + <para>Depending on the task itself and what kinds parameters and functionality it exposes, the task should define its own interface that inherits from this one, and then use that interface to communicate with the host.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Passes host objects from an integrated development environment (IDE) to individual tasks.</para> + </summary> </Docs> <Members /> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITaskItem.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITaskItem.xml index 8a7e0b5ce81..7dd74cebdb0 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITaskItem.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ITaskItem.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ITaskItem" FullName="Microsoft.Build.Framework.ITaskItem"> <TypeSignature Language="C#" Value="public interface ITaskItem" /> <AssemblyInfo> @@ -14,9 +15,23 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The number of <see cref="T:Microsoft.Build.Framework.ITaskItem" /> objects created during a build may not correspond exactly to items declared in a project file for the following reasons:</para> + <list type="bullet"> + <item> + <para>Tasks sometimes create items that were not declared in the project file.</para> + </item> + <item> + <para>An item collection can be declared in the project file with wildcards, which could create many items when built.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines an vstecmsbuild item that can be consumed and emitted by tasks. </para> + </summary> </Docs> <Members> <Member MemberName="CloneCustomMetadata"> @@ -27,10 +42,26 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> <returns>To be added.</returns> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <list type="bullet"> + <item> + <para>Does not include built-in metadata.</para> + </item> + <item> + <para>This method should return a clone of the metadata. </para> + </item> + <item> + <para>Writing to this dictionary should not be reflected in the underlying item.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the collection of custom metadata.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -46,10 +77,28 @@ <Parameter Name="destinationItem" Type="Microsoft.Build.Framework.ITaskItem" /> </Parameters> <Docs> - <param name="destinationItem">To be added.</param> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Follow the guidelines below when implementing this method.</para> + <list type="bullet"> + <item> + <para>Do not overwrite the <see cref="P:Microsoft.Build.Framework.ITaskItem.ItemSpec" /> property.</para> + </item> + <item> + <para>Do not overwrite existing metadata entries.</para> + </item> + <item> + <para>Do not copy metadata entries that do not make sense on the destination item.</para> + </item> + </list> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Copies the custom metadata entries to another item.</para> + </summary> + <param name="destinationItem"> + <attribution license="cc4" from="Microsoft" modified="false" />The item to copy the metadata entries to.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -65,11 +114,15 @@ <Parameter Name="metadataName" Type="System.String" /> </Parameters> <Docs> - <param name="metadataName">To be added.</param> - <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the value of the specified metadata entry.</para> + </summary> + <param name="metadataName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the metadata entry.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -82,10 +135,20 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The item specification is an arbitrary string. If the item represents a file on disk, the item specification will be the path of that file.</para> + <para>The <see cref="P:Microsoft.Build.Framework.ITaskItem.ItemSpec" /> for the following item declaration in a project file is File.cs.</para> + <code><ItemGroup> + <Compile Include="File.cs"/> +</ItemGroup></code> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets or sets the item specification.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -98,10 +161,13 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the number of metadata entries associated with the item.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -114,10 +180,13 @@ <ReturnType>System.Collections.ICollection</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the names of the metadata entries associated with the item.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -133,10 +202,14 @@ <Parameter Name="metadataName" Type="System.String" /> </Parameters> <Docs> - <param name="metadataName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Removes the specified metadata entry from the item.</para> + </summary> + <param name="metadataName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the metadata entry to remove.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -153,15 +226,20 @@ <Parameter Name="metadataValue" Type="System.String" /> </Parameters> <Docs> - <param name="metadataName">To be added.</param> - <param name="metadataValue">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Adds or changes a custom metadata entry to the item.</para> + </summary> + <param name="metadataName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the metadata entry.</param> + <param name="metadataValue"> + <attribution license="cc4" from="Microsoft" modified="false" />The value of the metadata entry.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoadInSeparateAppDomainAttribute.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoadInSeparateAppDomainAttribute.xml index f7a61edf3ee..8ddd2217da7 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoadInSeparateAppDomainAttribute.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoadInSeparateAppDomainAttribute.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="LoadInSeparateAppDomainAttribute" FullName="Microsoft.Build.Framework.LoadInSeparateAppDomainAttribute"> <TypeSignature Language="C#" Value="public sealed class LoadInSeparateAppDomainAttribute : Attribute" /> <AssemblyInfo> @@ -14,9 +15,12 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines the metadata attribute that vstecmsbuild uses to identify tasks that must be executed in their own application domains. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,13 +28,16 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.LoadInSeparateAppDomainAttribute" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoggerException.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoggerException.xml index f5947e2db2d..258bad31e1d 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoggerException.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoggerException.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="LoggerException" FullName="Microsoft.Build.Framework.LoggerException"> <TypeSignature Language="C#" Value="public class LoggerException : Exception" /> <AssemblyInfo> @@ -9,9 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>This exception can be used by a logger to indicate to a host that it has received invalid parameters, or can no longer continue logging for some reason, and wants to stop in a controlled way.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Allows a logger to force the build to stop in an explicit way. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +26,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.LoggerException" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -34,10 +44,14 @@ <Parameter Name="message" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.LoggerException" /> class with the specified values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The error message that explains the reason for the exception.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -51,11 +65,16 @@ <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <param name="context">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.LoggerException" /> class with the values specified.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -69,11 +88,16 @@ <Parameter Name="innerException" Type="System.Exception" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="innerException">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.LoggerException" /> class with the values specified.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The error message that explains the reason for the exception.</param> + <param name="innerException"> + <attribution license="cc4" from="Microsoft" modified="false" />The exception that is the cause of the current excpetion. If the <paramref name="innerException" /> parameter is not a null reference (Nothing in vbprvb), the current exception is raised in a catch block that handles the inner exception.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -89,13 +113,20 @@ <Parameter Name="helpKeyword" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="innerException">To be added.</param> - <param name="errorCode">To be added.</param> - <param name="helpKeyword">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.LoggerException" /> class with the values specified.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The error message that explains the reason for the exception.</param> + <param name="innerException"> + <attribution license="cc4" from="Microsoft" modified="false" />The exception that is the cause of the current excpetion. If the <paramref name="innerException" /> parameter is not a null reference (Nothing in vbprvb), the current exception is raised in a catch block that handles the inner exception.</param> + <param name="errorCode"> + <attribution license="cc4" from="Microsoft" modified="false" />The error code associated with the exception's message.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword for the error.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -108,10 +139,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the error code associated with this exception's message.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -131,10 +165,15 @@ <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" /> </Parameters> <Docs> - <param name="info">To be added.</param> - <param name="context">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with information about the exception.</para> + </summary> + <param name="info"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> + <param name="context"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> </Docs> </Member> <Member MemberName="HelpKeyword"> @@ -144,14 +183,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the F1-help keyword associated with this error.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoggerVerbosity.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoggerVerbosity.xml index f2a3cf94da7..718343c6045 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoggerVerbosity.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/LoggerVerbosity.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="LoggerVerbosity" FullName="Microsoft.Build.Framework.LoggerVerbosity"> <TypeSignature Language="C#" Value="public enum LoggerVerbosity" /> <AssemblyInfo> @@ -13,9 +14,15 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The descriptions of verbosity levels are only guidelines to how a typical logger (including the default vstecmsbuild console logger) logs build events. Loggers are free to interpret verbosity levels in any way they want.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies the available verbosity levels of a <see cref="T:Microsoft.Build.Utilities.Logger" />. </para> + </summary> </Docs> <Members> <Member MemberName="Detailed"> @@ -25,8 +32,11 @@ <ReturnType>Microsoft.Build.Framework.LoggerVerbosity</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Detailed verbosity, which displays errors, warnings, messages with <see cref="T:Microsoft.Build.Framework.MessageImportance" /> values of <see cref="F:Microsoft.Build.Framework.MessageImportance.High" /> or <see cref="F:Microsoft.Build.Framework.MessageImportance.Normal" />, all status events, and a build summary.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -39,8 +49,11 @@ <ReturnType>Microsoft.Build.Framework.LoggerVerbosity</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Diagnostic verbosity, which displays all errors, warnings, messages, status events, and a build summary.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -53,8 +66,11 @@ <ReturnType>Microsoft.Build.Framework.LoggerVerbosity</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Minimal verbosity, which displays errors, warnings, messages with <see cref="T:Microsoft.Build.Framework.MessageImportance" /> values of <see cref="F:Microsoft.Build.Framework.MessageImportance.High" />, and a build summary.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -67,8 +83,11 @@ <ReturnType>Microsoft.Build.Framework.LoggerVerbosity</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Normal verbosity, which displays errors, warnings, messages with <see cref="T:Microsoft.Build.Framework.MessageImportance" /> values of <see cref="F:Microsoft.Build.Framework.MessageImportance.High" />, some status events, and a build summary.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -81,12 +100,15 @@ <ReturnType>Microsoft.Build.Framework.LoggerVerbosity</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Quiet verbosity, which displays a build summary.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/MessageImportance.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/MessageImportance.xml index 04d404539a9..d6a75844b9a 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/MessageImportance.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/MessageImportance.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="MessageImportance" FullName="Microsoft.Build.Framework.MessageImportance"> <TypeSignature Language="C#" Value="public enum MessageImportance" /> <AssemblyInfo> @@ -8,9 +9,12 @@ <BaseTypeName>System.Enum</BaseTypeName> </Base> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Specifies constants that define the importance of a build message. </para> + </summary> </Docs> <Members> <Member MemberName="High"> @@ -20,8 +24,11 @@ <ReturnType>Microsoft.Build.Framework.MessageImportance</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A high importance message.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -34,8 +41,11 @@ <ReturnType>Microsoft.Build.Framework.MessageImportance</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A low importance message.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -48,12 +58,15 @@ <ReturnType>Microsoft.Build.Framework.MessageImportance</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>A normal importance message.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/OutputAttribute.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/OutputAttribute.xml index 9641acd3b94..9b375faa6dc 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/OutputAttribute.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/OutputAttribute.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="OutputAttribute" FullName="Microsoft.Build.Framework.OutputAttribute"> <TypeSignature Language="C#" Value="public sealed class OutputAttribute : Attribute" /> <AssemblyInfo> @@ -14,9 +15,16 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The vstecmsbuild engine will only allow task properties marked with this attribute to output data from a task. Project authors can only use properties marked with this attribute in the <unmanagedCodeEntityReference>Output</unmanagedCodeEntityReference> element of a project file. All other task properties are treated as inputs to a task.</para> + <para>For more information about using attributes, see <format type="text/html"><a href="30386922-1e00-4602-9ebf-526b271a8b87">Extending Metadata Using Attributes</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines the metadata attribute that task authors use to identify task properties that output data from the task. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,13 +32,16 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.OutputAttribute" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectFinishedEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectFinishedEventArgs.xml index a3a1f3239ab..11378a543c7 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectFinishedEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectFinishedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ProjectFinishedEventArgs" FullName="Microsoft.Build.Framework.ProjectFinishedEventArgs"> <TypeSignature Language="C#" Value="public class ProjectFinishedEventArgs : Microsoft.Build.Framework.BuildStatusEventArgs" /> <AssemblyInfo> @@ -9,9 +10,12 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.ProjectFinished" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +23,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.ProjectFinishedEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -37,13 +44,20 @@ <Parameter Name="succeeded" Type="System.Boolean" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="projectFile">To be added.</param> - <param name="succeeded">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.ProjectFinishedEventArgs" /> class with the specified <see cref="P:Microsoft.Build.Framework.BuildEventArgs.Message" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword" />, <see cref="P:Microsoft.Build.Framework.ProjectFinishedEventArgs.ProjectFile" />, and <see cref="P:Microsoft.Build.Framework.ProjectFinishedEventArgs.Succeeded" /> values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="projectFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The project file associated with the event.</param> + <param name="succeeded"> + <attribution license="cc4" from="Microsoft" modified="false" />true to indicate the build succeeded; otherwise, false.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -56,10 +70,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the project file associated with the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -72,14 +89,17 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the build succeeded.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectFinishedEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectFinishedEventHandler.xml index ec75b72f84c..569208e00b0 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectFinishedEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectFinishedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ProjectFinishedEventHandler" FullName="Microsoft.Build.Framework.ProjectFinishedEventHandler"> <TypeSignature Language="C#" Value="public delegate void ProjectFinishedEventHandler(object sender, ProjectFinishedEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.ProjectFinished" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectStartedEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectStartedEventArgs.xml index 919fc0bd0f5..942daddcec9 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectStartedEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectStartedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ProjectStartedEventArgs" FullName="Microsoft.Build.Framework.ProjectStartedEventArgs"> <TypeSignature Language="C#" Value="public class ProjectStartedEventArgs : Microsoft.Build.Framework.BuildStatusEventArgs" /> <AssemblyInfo> @@ -9,9 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>WARNING: marking a type [Serializable] without implementing ISerializable imposes a serialization contract -- it is a promise to never change the type's fields i.e. the type is immutable; adding new fields in the next version of the type without following certain special FX guidelines, can break both forward and backward compatibility</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.ProjectStarted" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +26,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.ProjectStartedEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -39,15 +49,24 @@ <Parameter Name="items" Type="System.Collections.IEnumerable" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="projectFile">To be added.</param> - <param name="targetNames">To be added.</param> - <param name="properties">To be added.</param> - <param name="items">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.ProjectStartedEventArgs" /> class with the specified values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="projectFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The project file name.</param> + <param name="targetNames"> + <attribution license="cc4" from="Microsoft" modified="false" />The targets to be built.</param> + <param name="properties"> + <attribution license="cc4" from="Microsoft" modified="false" />A list of properties</param> + <param name="items"> + <attribution license="cc4" from="Microsoft" modified="false" />A list of items.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -60,10 +79,19 @@ <ReturnType>System.Collections.IEnumerable</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The items and metadata accessed through <see cref="P:Microsoft.Build.Framework.ProjectStartedEventArgs.Items" /> are kept up-to-date and can be enumerated throughout the build of the project. However, changing an item in this list will not affect the build process.</para> + <block subset="none" type="note"> + <para>This property does not work with multi-proc builds. To get proper results, you can turn off multi-proc building by specifying /m:1 (which is the default).</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the list of items for the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -76,10 +104,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the project file associated with the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -92,10 +123,19 @@ <ReturnType>System.Collections.IEnumerable</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>The property names and values accessed through <see cref="P:Microsoft.Build.Framework.ProjectStartedEventArgs.Properties" /> are kept up-to-date and can be enumerated throughout the build of the project. However, changing a property in this list will not affect the build process.</para> + <block subset="none" type="note"> + <para>This property does not work with multi-proc builds. To get proper results, you can either turn off multi-proc building by specifying /m:1 (which is the default), or you can work around the limitation by setting an environment variable. For example, setting MSBuildForwardPropertiesFromChild=configuration;platform forwards the "configuration" and "platform" properties from the child nodes. Unless this environment variable is defined, nothing will be forwarded. For more information, see <format type="text/html"><a href="7f9e4469-8865-4b59-aab3-3ff26bd36e77">How To: Use Environment Variables in a Build</a></format>.</para> + </block> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the list of properties for the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -108,14 +148,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the list of targets to be built in the project.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectStartedEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectStartedEventHandler.xml index 6baf52bb6b8..53a3d7b9cc3 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectStartedEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/ProjectStartedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="ProjectStartedEventHandler" FullName="Microsoft.Build.Framework.ProjectStartedEventHandler"> <TypeSignature Language="C#" Value="public delegate void ProjectStartedEventHandler(object sender, ProjectStartedEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.ProjectStarted" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/RequiredAttribute.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/RequiredAttribute.xml index 07ae3cddbb9..945e361c900 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/RequiredAttribute.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/RequiredAttribute.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="RequiredAttribute" FullName="Microsoft.Build.Framework.RequiredAttribute"> <TypeSignature Language="C#" Value="public sealed class RequiredAttribute : Attribute" /> <AssemblyInfo> @@ -14,9 +15,16 @@ </Attribute> </Attributes> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>If a property marked with this attribute is not assigned a value when the task is invoked, the build will fail.</para> + <para>For more information about using attributes, see <format type="text/html"><a href="30386922-1e00-4602-9ebf-526b271a8b87">Extending Metadata Using Attributes</a></format>.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Defines the metadata attribute that task authors use to identify required task properties. Task properties with this attribute must have a set value when the task is run. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -24,13 +32,16 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.RequiredAttribute" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetFinishedEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetFinishedEventArgs.xml index 4c9ea634a45..98049ee0e5f 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetFinishedEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetFinishedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TargetFinishedEventArgs" FullName="Microsoft.Build.Framework.TargetFinishedEventArgs"> <TypeSignature Language="C#" Value="public class TargetFinishedEventArgs : Microsoft.Build.Framework.BuildStatusEventArgs" /> <AssemblyInfo> @@ -9,9 +10,15 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>WARNING: marking a type [Serializable] without implementing ISerializable imposes a serialization contract -- it is a promise to never change the type's fields i.e. the type is immutable; adding new fields in the next version of the type without following certain special FX guidelines, can break both forward and backward compatibility</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TargetFinishedEventArgs" /> class. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +26,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TargetFinishedEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -39,15 +49,24 @@ <Parameter Name="succeeded" Type="System.Boolean" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="targetName">To be added.</param> - <param name="projectFile">To be added.</param> - <param name="targetFile">To be added.</param> - <param name="succeeded">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TargetFinishedEventArgs" /> class with the specified <see cref="P:Microsoft.Build.Framework.BuildEventArgs.Message" />, <see cref="P:Microsoft.Build.Framework.BuildEventArgs.HelpKeyword" />, <see cref="P:Microsoft.Build.Framework.TargetFinishedEventArgs.TargetName" />, <see cref="P:Microsoft.Build.Framework.TargetFinishedEventArgs.ProjectFile" />, and <see cref="P:Microsoft.Build.Framework.TargetFinishedEventArgs.Succeeded" /> values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="targetName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the target associated with the event.</param> + <param name="projectFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the project file associated with the event.</param> + <param name="targetFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the target file.</param> + <param name="succeeded"> + <attribution license="cc4" from="Microsoft" modified="false" />true to indicate the build succeeded; otherwise, false.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -60,10 +79,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the project file associated with the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -76,10 +98,13 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the build of the target succeeded.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -92,10 +117,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the file that contains the implementation of this target.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -108,14 +136,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the target associated with the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetFinishedEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetFinishedEventHandler.xml index 87d61fc2ef1..ff3ef6a295b 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetFinishedEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetFinishedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TargetFinishedEventHandler" FullName="Microsoft.Build.Framework.TargetFinishedEventHandler"> <TypeSignature Language="C#" Value="public delegate void TargetFinishedEventHandler(object sender, TargetFinishedEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.TargetFinished" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetStartedEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetStartedEventArgs.xml index ace1756463d..7c71bd8639e 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetStartedEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetStartedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TargetStartedEventArgs" FullName="Microsoft.Build.Framework.TargetStartedEventArgs"> <TypeSignature Language="C#" Value="public class TargetStartedEventArgs : Microsoft.Build.Framework.BuildStatusEventArgs" /> <AssemblyInfo> @@ -9,9 +10,12 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.TargetStarted" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +23,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TargetStartedEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -38,14 +45,22 @@ <Parameter Name="targetFile" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="targetName">To be added.</param> - <param name="projectFile">To be added.</param> - <param name="targetFile">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initalizes a new instance of the <see cref="T:Microsoft.Build.Framework.TargetStartedEventArgs" /> class with the valudes provided.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="targetName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the target associated with the event.</param> + <param name="projectFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the project file associated with the event.</param> + <param name="targetFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the target file.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -58,10 +73,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the project file associated with the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -74,10 +92,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the file that contains the implementation of this target.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -90,14 +111,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the target associated with the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetStartedEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetStartedEventHandler.xml index 7f8c698e48f..9b364dc466e 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetStartedEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TargetStartedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TargetStartedEventHandler" FullName="Microsoft.Build.Framework.TargetStartedEventHandler"> <TypeSignature Language="C#" Value="public delegate void TargetStartedEventHandler(object sender, TargetStartedEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.TargetStarted" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskCommandLineEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskCommandLineEventArgs.xml index 49d5004737a..79bb517832e 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskCommandLineEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskCommandLineEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TaskCommandLineEventArgs" FullName="Microsoft.Build.Framework.TaskCommandLineEventArgs"> <TypeSignature Language="C#" Value="public class TaskCommandLineEventArgs : Microsoft.Build.Framework.BuildMessageEventArgs" /> <AssemblyInfo> @@ -9,9 +10,16 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> - <remarks>To be added.</remarks> <since version="2.0" /> + <remarks> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para> + <see cref="T:Microsoft.Build.Framework.TaskCommandLineEventArgs" /> extends <see cref="T:Microsoft.Build.Framework.BuildMessageEventArgs" /> so that the command line string used by a task to execute an underlying program can be logged as a message. Logging a command line string is only relevant for tasks that wrap an underlying program or emulate a shell command. Tasks that have no command line equivalent should not raise this extended message event.</para> + </remarks> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.MessageRaised" /> event.</para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +27,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TaskCommandLineEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -36,12 +47,18 @@ <Parameter Name="importance" Type="Microsoft.Build.Framework.MessageImportance" /> </Parameters> <Docs> - <param name="commandLine">To be added.</param> - <param name="taskName">To be added.</param> - <param name="importance">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TaskCommandLineEventArgs" /> class with the specified command line and <see cref="T:Microsoft.Build.Framework.MessageImportance" />.</para> + </summary> + <param name="commandLine"> + <attribution license="cc4" from="Microsoft" modified="false" />The command line used by the task to run the underlying program.</param> + <param name="taskName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the task raising the event.</param> + <param name="importance"> + <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.Framework.MessageImportance" /> of the message.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -54,10 +71,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the command line used by the task to run the underlying program.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -70,14 +90,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the task that raised the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskFinishedEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskFinishedEventArgs.xml index 139e2b9a0cf..c3af66136e3 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskFinishedEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskFinishedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TaskFinishedEventArgs" FullName="Microsoft.Build.Framework.TaskFinishedEventArgs"> <TypeSignature Language="C#" Value="public class TaskFinishedEventArgs : Microsoft.Build.Framework.BuildStatusEventArgs" /> <AssemblyInfo> @@ -9,9 +10,12 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.TaskFinished" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +23,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TaskFinishedEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -39,15 +46,24 @@ <Parameter Name="succeeded" Type="System.Boolean" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="projectFile">To be added.</param> - <param name="taskFile">To be added.</param> - <param name="taskName">To be added.</param> - <param name="succeeded">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TaskFinishedEventArgs" /> class with the specified values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text for the message.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="projectFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The project file name.</param> + <param name="taskFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The file in which the task is defined.</param> + <param name="taskName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the task.</param> + <param name="succeeded"> + <attribution license="cc4" from="Microsoft" modified="false" />true to indicate the task succeeded; otherwise, false.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -60,10 +76,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the project file associated with the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -76,10 +95,13 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets a value indicating whether the execution of the task succeeded.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -92,10 +114,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the vstecmsbuild file where the task is defined.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -108,14 +133,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the task associated with the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskFinishedEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskFinishedEventHandler.xml index 3bd196e34bb..ba38d83761f 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskFinishedEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskFinishedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TaskFinishedEventHandler" FullName="Microsoft.Build.Framework.TaskFinishedEventHandler"> <TypeSignature Language="C#" Value="public delegate void TaskFinishedEventHandler(object sender, TaskFinishedEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.TaskFinished" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskStartedEventArgs.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskStartedEventArgs.xml index bc44ca468d5..ad09448e254 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskStartedEventArgs.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskStartedEventArgs.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TaskStartedEventArgs" FullName="Microsoft.Build.Framework.TaskStartedEventArgs"> <TypeSignature Language="C#" Value="public class TaskStartedEventArgs : Microsoft.Build.Framework.BuildStatusEventArgs" /> <AssemblyInfo> @@ -9,9 +10,12 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Provides data for the <see cref="E:Microsoft.Build.Framework.IEventSource.TaskStarted" /> event. </para> + </summary> </Docs> <Members> <Member MemberName=".ctor"> @@ -19,9 +23,12 @@ <MemberType>Constructor</MemberType> <Parameters /> <Docs> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TaskStartedEventArgs" /> class.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -38,14 +45,22 @@ <Parameter Name="taskName" Type="System.String" /> </Parameters> <Docs> - <param name="message">To be added.</param> - <param name="helpKeyword">To be added.</param> - <param name="projectFile">To be added.</param> - <param name="taskFile">To be added.</param> - <param name="taskName">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.TaskStartedEventArgs" /> class with the specified values.</para> + </summary> + <param name="message"> + <attribution license="cc4" from="Microsoft" modified="false" />The text of the event.</param> + <param name="helpKeyword"> + <attribution license="cc4" from="Microsoft" modified="false" />The Help keyword associated with the event.</param> + <param name="projectFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the project file associated with the event.</param> + <param name="taskFile"> + <attribution license="cc4" from="Microsoft" modified="false" />The file in which the task is defined.</param> + <param name="taskName"> + <attribution license="cc4" from="Microsoft" modified="false" />The name of the task.</param> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -58,10 +73,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the project file associated with the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -74,10 +92,13 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the vstecmsbuild file where the task was defined.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> @@ -90,14 +111,17 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> <value>To be added.</value> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Gets the name of the task associated with the event.</para> + </summary> </Docs> <AssemblyInfo> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> </Member> </Members> -</Type> +</Type>
\ No newline at end of file diff --git a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskStartedEventHandler.xml b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskStartedEventHandler.xml index 8c2ec8a2e40..1cef4c2304b 100644 --- a/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskStartedEventHandler.xml +++ b/mcs/class/Microsoft.Build.Framework/Documentation/en/Microsoft.Build.Framework/TaskStartedEventHandler.xml @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> <Type Name="TaskStartedEventHandler" FullName="Microsoft.Build.Framework.TaskStartedEventHandler"> <TypeSignature Language="C#" Value="public delegate void TaskStartedEventHandler(object sender, TaskStartedEventArgs e);" /> <AssemblyInfo> @@ -17,8 +18,11 @@ <Docs> <param name="sender">To be added.</param> <param name="e">To be added.</param> - <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="2.0" /> + <summary> + <attribution license="cc4" from="Microsoft" modified="false" /> + <para>Represents the method that will handle the <see cref="E:Microsoft.Build.Framework.IEventSource.TaskStarted" /> event of a build. </para> + </summary> </Docs> -</Type> +</Type>
\ No newline at end of file |