mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Imported Upstream version 3.6.0

Browse Source 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
This commit is contained in:
Jo Shields
2014-08-13 10:39:27 +01:00
commit a575963da9
50588 changed files with 8155799 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

251
mcs/class/Microsoft.Build.Utilities/Documentation/en/Microsoft.Build.Utilities/AppDomainIsolatedTask.xml Normal file
View File

@@ -0,0 +1,251 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="AppDomainIsolatedTask" FullName="Microsoft.Build.Utilities.AppDomainIsolatedTask">
<TypeSignature Language="C#" Value="public abstract class AppDomainIsolatedTask : MarshalByRefObject, Microsoft.Build.Framework.ITask" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.MarshalByRefObject</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Build.Framework.ITask</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>Microsoft.Build.Framework.LoadInSeparateAppDomain</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides the same functionality as <see cref="T:Microsoft.Build.Utilities.Task" />, but also derives from <see cref="T:System.MarshalByRefObject" /> so that it can be instantiated in its own app domain.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected AppDomainIsolatedTask ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<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.Utilities.AppDomainIsolatedTask" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected AppDomainIsolatedTask (System.Resources.ResourceManager taskResources);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="taskResources" Type="System.Resources.ResourceManager" />
</Parameters>
<Docs>
<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.Utilities.AppDomainIsolatedTask" /> class and allows derived <see cref="T:Microsoft.Build.Utilities.Task" /> classes to register their resources.</para>
</summary>
<param name="taskResources">
<attribution license="cc4" from="Microsoft" modified="false" />The task resources.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected AppDomainIsolatedTask (System.Resources.ResourceManager taskResources, string helpKeywordPrefix);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="taskResources" Type="System.Resources.ResourceManager" />
<Parameter Name="helpKeywordPrefix" Type="System.String" />
</Parameters>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the prefix is an empty string, then string resource names will be used verbatim as Help keywords. For an example of how the prefix is used, see the <see cref="M:Microsoft.Build.Utilities.TaskLoggingHelper.LogErrorWithCodeFromResources(System.String,System.Object[])" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:Microsoft.Build.Utilities.AppDomainIsolatedTask" /> class and allows derived <see cref="T:Microsoft.Build.Utilities.Task" /> classes to register their resources, as well as provide a prefix for composing help keywords from string resource names.</para>
</summary>
<param name="taskResources">
<attribution license="cc4" from="Microsoft" modified="false" />The task resources.</param>
<param name="helpKeywordPrefix">
<attribution license="cc4" from="Microsoft" modified="false" />The Help keyword prefix.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildEngine">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.IBuildEngine BuildEngine { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.IBuildEngine</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The build engine automatically sets this property to allow tasks to call back into it.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the build engine interface that is available to tasks.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Execute">
<MemberSignature Language="C#" Value="public abstract bool Execute ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method must be implemented by the derived class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Runs the task.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if successful; otherwise, false.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="HelpKeywordPrefix">
<MemberSignature Language="C#" Value="protected string HelpKeywordPrefix { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the <see cref="M:Microsoft.Build.Utilities.TaskLoggingHelper.LogErrorWithCodeFromResources(System.String,System.Object[])" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the prefix that is used to compose Help keywords from string resource names.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="HostObject">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.ITaskHost HostObject { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.ITaskHost</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The build engine sets this property if the host IDE has associated a host object with this particular task.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a host object instance that is associated with the derived <see cref="T:Microsoft.Build.Utilities.Task" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="InitializeLifetimeService">
<MemberSignature Language="C#" Value="public override object InitializeLifetimeService ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Otherwise, a limited lease of 5 minutes will result; and task instances can expire if they take a long time to process.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, gives tasks infinite lease time.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>null to specify an infinite lifetime.</para>
</returns>
</Docs>
</Member>
<Member MemberName="Log">
<MemberSignature Language="C#" Value="public Microsoft.Build.Utilities.TaskLoggingHelper Log { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Utilities.TaskLoggingHelper</ReturnType>
</ReturnValue>
<Docs>
<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 instance of a task logging helper object that contains task logging methods.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TaskResources">
<MemberSignature Language="C#" Value="protected System.Resources.ResourceManager TaskResources { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Resources.ResourceManager</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Derived classes should register their resources either during construction, or through this property, if they have localized strings.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets culture-specific resources of the derived <see cref="T:Microsoft.Build.Utilities.Task" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

626
mcs/class/Microsoft.Build.Utilities/Documentation/en/Microsoft.Build.Utilities/CommandLineBuilder.xml Normal file
View File

File diff suppressed because it is too large Load Diff

93
mcs/class/Microsoft.Build.Utilities/Documentation/en/Microsoft.Build.Utilities/HostObjectInitializationStatus.xml Normal file
View File

@@ -0,0 +1,93 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HostObjectInitializationStatus" FullName="Microsoft.Build.Utilities.HostObjectInitializationStatus">
<TypeSignature Language="C#" Value="public enum HostObjectInitializationStatus" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:Microsoft.Build.Utilities.HostObjectInitializationStatus" /> is the return type of the <see cref="M:Microsoft.Build.Utilities.ToolTask.InitializeHostObject" /> method of the <see cref="T:Microsoft.Build.Utilities.ToolTask" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines the next action for <see cref="T:Microsoft.Build.Utilities.ToolTask" /> after an attempt to initialize the host object.</para>
</summary>
</Docs>
<Members>
<Member MemberName="NoActionReturnFailure">
<MemberSignature Language="C#" Value="NoActionReturnFailure" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Utilities.HostObjectInitializationStatus</ReturnType>
</ReturnValue>
<Docs>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates that some of the parameters being passed into the task are invalid, and that the task should fail immediately.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="NoActionReturnSuccess">
<MemberSignature Language="C#" Value="NoActionReturnSuccess" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Utilities.HostObjectInitializationStatus</ReturnType>
</ReturnValue>
<Docs>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates that the host object is up to date, and that no further action is necessary.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UseAlternateToolToExecute">
<MemberSignature Language="C#" Value="UseAlternateToolToExecute" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Utilities.HostObjectInitializationStatus</ReturnType>
</ReturnValue>
<Docs>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates that either a host object is not available, or that the host object is not capable of supporting all of the features required for this build. Therefore, <see cref="T:Microsoft.Build.Utilities.ToolTask" /> should fallback to an alternate means of doing the build, such as invoking the command-line tool.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UseHostObjectToExecute">
<MemberSignature Language="C#" Value="UseHostObjectToExecute" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Utilities.HostObjectInitializationStatus</ReturnType>
</ReturnValue>
<Docs>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates that an appropriate host object for this task exists, which can support all of the parameters passed in and should be invoked to do the real work of the task.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

218
mcs/class/Microsoft.Build.Utilities/Documentation/en/Microsoft.Build.Utilities/Logger.xml Normal file
View File

@@ -0,0 +1,218 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="Logger" FullName="Microsoft.Build.Utilities.Logger">
<TypeSignature Language="C#" Value="public abstract class Logger : Microsoft.Build.Framework.ILogger" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Build.Framework.ILogger</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This abstract class provides default implementations for the methods and properties of the <see cref="T:Microsoft.Build.Framework.ILogger" /> interface.</para>
<para>This class can only be instantiated in a derived form.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived form, provides functionality for loggers that handle events raised by the vstecmsbuild engine.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Logger ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<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.Utilities.Logger" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FormatErrorEvent">
<MemberSignature Language="C#" Value="public virtual string FormatErrorEvent (Microsoft.Build.Framework.BuildErrorEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="args" Type="Microsoft.Build.Framework.BuildErrorEventArgs" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Generates an error message that is in the default format, from a <see cref="T:Microsoft.Build.Framework.BuildErrorEventArgs" /> object.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.String" /> that represents an error message in canonical format.</para>
</returns>
<param name="args">
<attribution license="cc4" from="Microsoft" modified="false" />The arguments of the error event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FormatWarningEvent">
<MemberSignature Language="C#" Value="public virtual string FormatWarningEvent (Microsoft.Build.Framework.BuildWarningEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="args" Type="Microsoft.Build.Framework.BuildWarningEventArgs" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Generates a warning message that is in the default format, from a <see cref="T:Microsoft.Build.Framework.BuildWarningEventArgs" /> object.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.String" /> that represents a warning message in canonical format.</para>
</returns>
<param name="args">
<attribution license="cc4" from="Microsoft" modified="false" />The arguments of the warning event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public abstract void Initialize (Microsoft.Build.Framework.IEventSource eventSource);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="eventSource" Type="Microsoft.Build.Framework.IEventSource" />
</Parameters>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method must be overridden in the derived class to perform initialization logic and to subscribe to build events published by <see cref="T:Microsoft.Build.Framework.IEventSource" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, subscribes the logger to specific events.</para>
</summary>
<param name="eventSource">
<attribution license="cc4" from="Microsoft" modified="false" />The available events that a logger can subscribe to.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsVerbosityAtLeast">
<MemberSignature Language="C#" Value="public bool IsVerbosityAtLeast (Microsoft.Build.Framework.LoggerVerbosity verbosity);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="verbosity" Type="Microsoft.Build.Framework.LoggerVerbosity" />
</Parameters>
<Docs>
<param name="verbosity">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the current <see cref="P:Microsoft.Build.Utilities.Logger.Verbosity" /> setting is at least the value that is passed in.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the current logger verbosity setting is at least the value that is passed in; otherwise, false.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parameters">
<MemberSignature Language="C#" Value="public virtual string Parameters { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the derived class does not take parameters, then it can ignore this property.</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>
</AssemblyInfo>
</Member>
<Member MemberName="Shutdown">
<MemberSignature Language="C#" Value="public virtual void Shutdown ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method can be overridden in the derived class to perform shutdown logic, such as releasing acquired resources.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, releases the resources allocated to the logger at the time of initialization or during the build.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Verbosity">
<MemberSignature Language="C#" Value="public virtual Microsoft.Build.Framework.LoggerVerbosity Verbosity { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.LoggerVerbosity</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<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>

72
mcs/class/Microsoft.Build.Utilities/Documentation/en/Microsoft.Build.Utilities/TargetDotNetFrameworkVersion.xml Normal file
View File

@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="TargetDotNetFrameworkVersion" FullName="Microsoft.Build.Utilities.TargetDotNetFrameworkVersion">
<TypeSignature Language="C#" Value="public enum TargetDotNetFrameworkVersion" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies the version of the dnprdnshort to use with the methods in <see cref="T:Microsoft.Build.Utilities.ToolLocationHelper" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Version11">
<MemberSignature Language="C#" Value="Version11" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Utilities.TargetDotNetFrameworkVersion</ReturnType>
</ReturnValue>
<Docs>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies dnprdnshort version 1.1.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Version20">
<MemberSignature Language="C#" Value="Version20" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Utilities.TargetDotNetFrameworkVersion</ReturnType>
</ReturnValue>
<Docs>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies dnprdnshort version 2.0.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="VersionLatest">
<MemberSignature Language="C#" Value="VersionLatest" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Utilities.TargetDotNetFrameworkVersion</ReturnType>
</ReturnValue>
<Docs>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies the most recent released version of the dnprdnshort.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

229
mcs/class/Microsoft.Build.Utilities/Documentation/en/Microsoft.Build.Utilities/Task.xml Normal file
View File

@@ -0,0 +1,229 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="Task" FullName="Microsoft.Build.Utilities.Task">
<TypeSignature Language="C#" Value="public abstract class Task : Microsoft.Build.Framework.ITask" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Build.Framework.ITask</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This abstract class provides default implementations for the methods and properties of the <see cref="T:Microsoft.Build.Framework.ITask" /> interface.</para>
<para>This class can only be instantiated in a derived form.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived form, provides functionality for tasks.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Task ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<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.Utilities.Task" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Task (System.Resources.ResourceManager taskResources);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="taskResources" Type="System.Resources.ResourceManager" />
</Parameters>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor allows derived task classes to register their resources.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:Microsoft.Build.Utilities.Task" /> class with the specified <see cref="P:Microsoft.Build.Utilities.Task.TaskResources" />.</para>
</summary>
<param name="taskResources">
<attribution license="cc4" from="Microsoft" modified="false" />The task resources.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Task (System.Resources.ResourceManager taskResources, string helpKeywordPrefix);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="taskResources" Type="System.Resources.ResourceManager" />
<Parameter Name="helpKeywordPrefix" Type="System.String" />
</Parameters>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor allows derived task classes to register their resources, as well as provide a prefix for composing help keywords from string resource names. If <paramref name="helpKeywordPrefix" /> is an empty string, string resource names will be used verbatim as help keywords.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:Microsoft.Build.Utilities.Task" /> class with the specified <see cref="P:Microsoft.Build.Utilities.Task.TaskResources" /> and <see cref="P:Microsoft.Build.Utilities.Task.HelpKeywordPrefix" />.</para>
</summary>
<param name="taskResources">
<attribution license="cc4" from="Microsoft" modified="false" />The task resources.</param>
<param name="helpKeywordPrefix">
<attribution license="cc4" from="Microsoft" modified="false" />The prefix to append to string resources to create Help keywords.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildEngine">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.IBuildEngine BuildEngine { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.IBuildEngine</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The build engine automatically sets this property to allow tasks to call back into it.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the instance of the <see cref="T:Microsoft.Build.Framework.IBuildEngine" /> object used by the task.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Execute">
<MemberSignature Language="C#" Value="public abstract bool Execute ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This class must be overridden in a derived class, and is used for performing task execution logic.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, executes the task.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the task successfully executed; otherwise, false.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="HelpKeywordPrefix">
<MemberSignature Language="C#" Value="protected string HelpKeywordPrefix { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If a task does not have Help keywords associated with its messages, it can ignore this property or set it to null. If this property is set to an empty <see cref="T:System.String" />, resource names will be used verbatim as Help keywords.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the prefix used to compose Help keywords from resource names.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="HostObject">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.ITaskHost HostObject { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.ITaskHost</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the host IDE has associated a host object with this particular task, then the build engine sets this property.</para>
<para>The host object is provided by <see cref="T:Microsoft.Build.Execution.HostServices" />. Visual Studio determines the host object via a system registry key. For more information, see <see cref="T:Microsoft.VisualStudio.Shell.Interop.IVsMSBuildHostObject" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the host object associated with the task.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Log">
<MemberSignature Language="C#" Value="public Microsoft.Build.Utilities.TaskLoggingHelper Log { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Utilities.TaskLoggingHelper</ReturnType>
</ReturnValue>
<Docs>
<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 instance of a <see cref="T:Microsoft.Build.Utilities.TaskLoggingHelper" /> class containing task logging methods.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TaskResources">
<MemberSignature Language="C#" Value="protected System.Resources.ResourceManager TaskResources { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Resources.ResourceManager</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If derived classes have localized strings, then they should register their resources either during construction, or through this property.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the culture-specific resources associated with the task.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

372
mcs/class/Microsoft.Build.Utilities/Documentation/en/Microsoft.Build.Utilities/TaskItem.xml Normal file
View File

@@ -0,0 +1,372 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="TaskItem" FullName="Microsoft.Build.Utilities.TaskItem">
<TypeSignature Language="C#" Value="public sealed class TaskItem : MarshalByRefObject, Microsoft.Build.Framework.ITaskItem" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.MarshalByRefObject</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Build.Framework.ITaskItem</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:Microsoft.Build.Utilities.TaskItem" /> objects do not exactly correspond to item elements in project files. If they did, then tasks would have access to data that was not explicitly passed into the task through the project file. This is not a security issue, but rather an issue with project file clarity and transparency.</para>
<para>This class has to be sealed since the build engine instantiates its own copy of this type. If a third party were to extend this class, then the build engine will yield an undesired behavior.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines a single item of the project as it is passed into a task.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TaskItem ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor enables this type to be COM-creatable.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:Microsoft.Build.Utilities.TaskItem" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TaskItem (Microsoft.Build.Framework.ITaskItem sourceItem);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="sourceItem" Type="Microsoft.Build.Framework.ITaskItem" />
</Parameters>
<Docs>
<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.Utilities.TaskItem" /> class using the specified source <see cref="T:Microsoft.Build.Framework.ITaskItem" />.</para>
</summary>
<param name="sourceItem">
<attribution license="cc4" from="Microsoft" modified="false" />The item to copy.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TaskItem (string itemSpec);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="itemSpec" Type="System.String" />
</Parameters>
<Docs>
<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.Utilities.TaskItem" /> class using the specified item-specification string.</para>
</summary>
<param name="itemSpec">
<attribution license="cc4" from="Microsoft" modified="false" />The item specification.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TaskItem (string itemSpec, System.Collections.IDictionary itemMetadata);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="itemSpec" Type="System.String" />
<Parameter Name="itemMetadata" Type="System.Collections.IDictionary" />
</Parameters>
<Docs>
<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.Utilities.TaskItem" /> class using the specified item-specification string and its metadata.</para>
</summary>
<param name="itemSpec">
<attribution license="cc4" from="Microsoft" modified="false" />The item specification.</param>
<param name="itemMetadata">
<attribution license="cc4" from="Microsoft" modified="false" />The custom metadata for the item specification.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CloneCustomMetadata">
<MemberSignature Language="C#" Value="public System.Collections.IDictionary CloneCustomMetadata ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IDictionary</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method does not include built-in metadata.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Clones the collection of custom metadata for the item specification.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Collections.IDictionary" /> that represents a clone of the custom metadata.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CopyMetadataTo">
<MemberSignature Language="C#" Value="public void CopyMetadataTo (Microsoft.Build.Framework.ITaskItem destinationItem);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="destinationItem" Type="Microsoft.Build.Framework.ITaskItem" />
</Parameters>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the metadata already exists on the destination item, then it is not overwritten. The original metadata value supersedes the copied metadata value.</para>
<para>This method does not copy the item specification to the destination task item.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Copies the item-specification metadata to the specified destination task item.</para>
</summary>
<param name="destinationItem">
<attribution license="cc4" from="Microsoft" modified="false" />The item that this method will copy metadata to.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetMetadata">
<MemberSignature Language="C#" Value="public string GetMetadata (string metadataName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves the specified metadata on the item.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.String" /> that represents the metadata value.</para>
</returns>
<param name="metadataName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the metadata to retrieve.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="InitializeLifetimeService">
<MemberSignature Language="C#" Value="public override object InitializeLifetimeService ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Otherwise, a limited lease of 5 minutes will result; and task instances can expire if they take a long time to process.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, gives task items infinite lease time.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>null to specify an infinite lifetime.</para>
</returns>
</Docs>
</Member>
<Member MemberName="ItemSpec">
<MemberSignature Language="C#" Value="public string ItemSpec { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:Microsoft.Build.Framework.ITaskItem.ItemSpec" /> for the following item declaration in a project file is File.cs.</para>
<code>&lt;ItemGroup&gt;
&lt;Compile Include="File.cs"/&gt;
&lt;/ItemGroup&gt;</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>
</AssemblyInfo>
</Member>
<Member MemberName="MetadataCount">
<MemberSignature Language="C#" Value="public int MetadataCount { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<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 set on the item.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MetadataNames">
<MemberSignature Language="C#" Value="public System.Collections.ICollection MetadataNames { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.ICollection</ReturnType>
</ReturnValue>
<Docs>
<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 all the metadata on the item.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="op_Explicit">
<MemberSignature Language="C#" Value="public static string op_Explicit (Microsoft.Build.Utilities.TaskItem taskItemToCast);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskItemToCast" Type="Microsoft.Build.Utilities.TaskItem" />
</Parameters>
<Docs>
<param name="taskItemToCast">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RemoveMetadata">
<MemberSignature Language="C#" Value="public void RemoveMetadata (string metadataName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes the specified metadata on the item.</para>
</summary>
<param name="metadataName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of metadata to remove.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SetMetadata">
<MemberSignature Language="C#" Value="public void SetMetadata (string metadataName, string metadataValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataName" Type="System.String" />
<Parameter Name="metadataValue" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets or modifies the value of the specified metadata on the item.</para>
</summary>
<param name="metadataName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of metadata to set or modify.</param>
<param name="metadataValue">
<attribution license="cc4" from="Microsoft" modified="false" />The new value of metadata.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the item specification.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.String" /> that represents the item specification.</para>
</returns>
</Docs>
</Member>
</Members>
</Type>

1305
mcs/class/Microsoft.Build.Utilities/Documentation/en/Microsoft.Build.Utilities/TaskLoggingHelper.xml Normal file
View File

File diff suppressed because it is too large Load Diff

276
mcs/class/Microsoft.Build.Utilities/Documentation/en/Microsoft.Build.Utilities/ToolLocationHelper.xml Normal file
View File

@@ -0,0 +1,276 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ToolLocationHelper" FullName="Microsoft.Build.Utilities.ToolLocationHelper">
<TypeSignature Language="C#" Value="public static class ToolLocationHelper" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Utilities</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides utility methods for locating dnprdnshort and dnprdnshort SDK files and directories.</para>
</summary>
</Docs>
<Members>
<Member MemberName="GetDotNetFrameworkRootRegistryKey">
<MemberSignature Language="C#" Value="public static string GetDotNetFrameworkRootRegistryKey (Microsoft.Build.Utilities.TargetDotNetFrameworkVersion version);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="version" Type="Microsoft.Build.Utilities.TargetDotNetFrameworkVersion" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the full name of the dnprdnshort root registry key.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A string containing the full name of the dnprdnshort root registry key.</para>
</returns>
<param name="version">
<attribution license="cc4" from="Microsoft" modified="false" />The version of the dnprdnshort to target.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetDotNetFrameworkSdkInstallKeyValue">
<MemberSignature Language="C#" Value="public static string GetDotNetFrameworkSdkInstallKeyValue (Microsoft.Build.Utilities.TargetDotNetFrameworkVersion version);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="version" Type="Microsoft.Build.Utilities.TargetDotNetFrameworkVersion" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the value under the <see cref="M:Microsoft.Build.Utilities.ToolLocationHelper.GetDotNetFrameworkRootRegistryKey(Microsoft.Build.Utilities.TargetDotNetFrameworkVersion)" /> that contains the dnprdnshort SDK installation path.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a string containing the name of the registry key value under the <see cref="M:Microsoft.Build.Utilities.ToolLocationHelper.GetDotNetFrameworkRootRegistryKey(Microsoft.Build.Utilities.TargetDotNetFrameworkVersion)" /> that contains the dnprdnshort SDK installation path.</para>
</returns>
<param name="version">
<attribution license="cc4" from="Microsoft" modified="false" />The version of the dnprdnshort to target.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetDotNetFrameworkVersionFolderPrefix">
<MemberSignature Language="C#" Value="public static string GetDotNetFrameworkVersionFolderPrefix (Microsoft.Build.Utilities.TargetDotNetFrameworkVersion version);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="version" Type="Microsoft.Build.Utilities.TargetDotNetFrameworkVersion" />
</Parameters>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An example of the value returned is the string "v2.0".</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the prefix of the dnprdnshort folder.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the prefix of the dnprdnshort folder.</para>
</returns>
<param name="version">
<attribution license="cc4" from="Microsoft" modified="false" />The version of the dnprdnshort to target.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetPathToDotNetFramework">
<MemberSignature Language="C#" Value="public static string GetPathToDotNetFramework (Microsoft.Build.Utilities.TargetDotNetFrameworkVersion version);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="version" Type="Microsoft.Build.Utilities.TargetDotNetFrameworkVersion" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a fully qualified path to the dnprdnshort root directory.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A string containing the fully qualified path to the dnprdnshort root directory, or a null reference (Nothing in vbprvb) if the targeted version of the dnprdnshort is not installed.</para>
</returns>
<param name="version">
<attribution license="cc4" from="Microsoft" modified="false" />The version of the dnprdnshort to target.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetPathToDotNetFrameworkFile">
<MemberSignature Language="C#" Value="public static string GetPathToDotNetFrameworkFile (string fileName, Microsoft.Build.Utilities.TargetDotNetFrameworkVersion version);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fileName" Type="System.String" />
<Parameter Name="version" Type="Microsoft.Build.Utilities.TargetDotNetFrameworkVersion" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a fully qualified path to a file in the dnprdnshort directory.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A string containing the fully qualified path to the specified file, or a null reference (Nothing in vbprvb) if the targeted version of the dnprdnshort is not installed.</para>
</returns>
<param name="fileName">
<attribution license="cc4" from="Microsoft" modified="false" />The file to locate in the dnprdnshort directory.</param>
<param name="version">
<attribution license="cc4" from="Microsoft" modified="false" />The version of the dnprdnshort to target.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetPathToDotNetFrameworkSdk">
<MemberSignature Language="C#" Value="public static string GetPathToDotNetFrameworkSdk (Microsoft.Build.Utilities.TargetDotNetFrameworkVersion version);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="version" Type="Microsoft.Build.Utilities.TargetDotNetFrameworkVersion" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the fully qualified path to the \bin directory of the dnprdnshort SDK.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A string containing the fully qualified path to the \bin directory of the dnprdnshort SDK, or a null reference (Nothing in vbprvb) if the targeted version of the dnprdnshort SDK is not installed.</para>
</returns>
<param name="version">
<attribution license="cc4" from="Microsoft" modified="false" />The version of the dnprdnshort to target.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetPathToDotNetFrameworkSdkFile">
<MemberSignature Language="C#" Value="public static string GetPathToDotNetFrameworkSdkFile (string fileName, Microsoft.Build.Utilities.TargetDotNetFrameworkVersion version);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fileName" Type="System.String" />
<Parameter Name="version" Type="Microsoft.Build.Utilities.TargetDotNetFrameworkVersion" />
</Parameters>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The path for the SDK takes in consideration the processor architecture environment information for the calling process, so it might end up being ".../bin/i64", for example.</para>
<para>Unlike <see cref="M:Microsoft.Build.Utilities.ToolLocationHelper.GetPathToDotNetFrameworkFile(System.String,Microsoft.Build.Utilities.TargetDotNetFrameworkVersion)" /> and <see cref="M:Microsoft.Build.Utilities.ToolLocationHelper.GetPathToSystemFile(System.String)" /> this method checks for the existence of the file, so that an invalid <paramref name="fileName" /> returns null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the fully qualified path to a file in the dnprdnshort SDK.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A string containing the fully qualified path to the \bin directory of the dnprdnshort SDK, or a null reference (Nothing in vbprvb) if the targeted version of the dnprdnshort SDK is not installed.</para>
</returns>
<param name="fileName">
<attribution license="cc4" from="Microsoft" modified="false" />The file to locate in the dnprdnshort SDK.</param>
<param name="version">
<attribution license="cc4" from="Microsoft" modified="false" />The version of the dnprdnshort to target.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetPathToSystemFile">
<MemberSignature Language="C#" Value="public static string GetPathToSystemFile (string fileName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fileName" Type="System.String" />
</Parameters>
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This API builds the full path plus filename for a file in the System folder. It doesn't check for the existence of the file prior to returning.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a fully qualified path to a file in the system directory.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A string containing the fully qualified path to the the file in the system directory.</para>
</returns>
<param name="fileName">
<attribution license="cc4" from="Microsoft" modified="false" />The file to locate in the System folder.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PathToSystem">
<MemberSignature Language="C#" Value="public static string PathToSystem { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An example of the value returned is the string "C:\WinNT\System32".</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the fully qualified path of the system directory.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

677
mcs/class/Microsoft.Build.Utilities/Documentation/en/Microsoft.Build.Utilities/ToolTask.xml Normal file
View File

File diff suppressed because it is too large Load Diff

70
mcs/class/Microsoft.Build.Utilities/Documentation/en/index.xml Normal file
View File

@@ -0,0 +1,70 @@
<Overview>
<Assemblies>
<Assembly Name="Microsoft.Build.Utilities" Version="2.0.0.0">
<Attributes>
<Attribute>
<AttributeName>System.Runtime.CompilerServices.RuntimeCompatibility(WrapNonExceptionThrows=true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Diagnostics.Debuggable(System.Diagnostics.DebuggableAttribute+DebuggingModes.IgnoreSymbolStoreSequencePoints)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.CompilerServices.CompilationRelaxations(System.Runtime.CompilerServices.CompilationRelaxations.NoStringInterning)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyFileVersion("2.0.50727.1433")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.CLSCompliant(true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Resources.NeutralResourcesLanguage("en-US")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyInformationalVersion("2.0.50727.1433")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Resources.SatelliteContractVersion("2.0.0.0")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyCopyright("(c) various MONO Authors")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyProduct("MONO Common language infrastructure")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyCompany("MONO development team")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyDefaultAlias("Microsoft.Build.Utilities.dll")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyDescription("Microsoft.Build.Utilities.dll")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyTitle("Microsoft.Build.Utilities.dll")</AttributeName>
</Attribute>
</Attributes>
</Assembly>
</Assemblies>
<Remarks>To be added.</Remarks>
<Copyright>To be added.</Copyright>
<Types>
<Namespace Name="Microsoft.Build.Utilities">
<Type Name="AppDomainIsolatedTask" Kind="Class" />
<Type Name="CommandLineBuilder" Kind="Class" />
<Type Name="HostObjectInitializationStatus" Kind="Enumeration" />
<Type Name="Logger" Kind="Class" />
<Type Name="TargetDotNetFrameworkVersion" Kind="Enumeration" />
<Type Name="Task" Kind="Class" />
<Type Name="TaskItem" Kind="Class" />
<Type Name="TaskLoggingHelper" Kind="Class" />
<Type Name="ToolLocationHelper" Kind="Class" />
<Type Name="ToolTask" Kind="Class" />
</Namespace>
</Types>
<Title>Microsoft.Build.Utilities</Title>
</Overview>

10
mcs/class/Microsoft.Build.Utilities/Documentation/en/ns-Microsoft.Build.Utilities.xml Normal file
View File

@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<Namespace Name="Microsoft.Build.Utilities">
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="N:Microsoft.Build.Utilities" /> namespace provides helper classes that you can use to create your own MSBuild loggers and tasks. For information, see <format type="text/html"><a href="e39f13f7-1e1d-4435-95ca-0c222bca071c">MSBuild</a></format>.</para>
</summary>
</Docs>
</Namespace>