mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
linux-packaging-mono/mcs/class/Microsoft.Build.Engine/Documentation/en/Microsoft.Build.BuildEngine/ConsoleLogger.xml
Jo Shields a575963da9 Imported Upstream version 3.6.0 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

557 lines
24 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8"?>
<Type Name="ConsoleLogger" FullName="Microsoft.Build.BuildEngine.ConsoleLogger">
<TypeSignature Language="C#" Value="public class ConsoleLogger : Microsoft.Build.Framework.ILogger" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</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>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Implements the standard console logger that outputs event data to the console window during a build.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConsoleLogger ();" />
<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.BuildEngine.ConsoleLogger" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConsoleLogger (Microsoft.Build.Framework.LoggerVerbosity verbosity);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="verbosity" Type="Microsoft.Build.Framework.LoggerVerbosity" />
</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.BuildEngine.ConsoleLogger" /> class with the specified <see cref="T:Microsoft.Build.Framework.LoggerVerbosity" />.</para>
</summary>
<param name="verbosity">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.Framework.LoggerVerbosity" /> to apply to the logger.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConsoleLogger (Microsoft.Build.Framework.LoggerVerbosity verbosity, Microsoft.Build.BuildEngine.WriteHandler write, Microsoft.Build.BuildEngine.ColorSetter colorSet, Microsoft.Build.BuildEngine.ColorResetter colorReset);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="verbosity" Type="Microsoft.Build.Framework.LoggerVerbosity" />
<Parameter Name="write" Type="Microsoft.Build.BuildEngine.WriteHandler" />
<Parameter Name="colorSet" Type="Microsoft.Build.BuildEngine.ColorSetter" />
<Parameter Name="colorReset" Type="Microsoft.Build.BuildEngine.ColorResetter" />
</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.BuildEngine.ConsoleLogger" /> class with the specified <see cref="T:Microsoft.Build.Framework.LoggerVerbosity" />, <see cref="T:Microsoft.Build.BuildEngine.ColorSetter" />, and <see cref="T:Microsoft.Build.BuildEngine.ColorResetter" /> values.</para>
</summary>
<param name="verbosity">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.Framework.LoggerVerbosity" /> to apply to the logger.</param>
<param name="write">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.WriteHandler" /> for the logger to use.</param>
<param name="colorSet">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.ColorSetter" /> for the logger to use.</param>
<param name="colorReset">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.ColorResetter" /> for the logger to use.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ApplyParameter">
<MemberSignature Language="C#" Value="public void ApplyParameter (string parameterName, string parameterValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="parameterName" Type="System.String" />
<Parameter Name="parameterValue" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds the specified parameter name and value to the logger.</para>
</summary>
<param name="parameterName">
<attribution license="cc4" from="Microsoft" modified="false" />The parameter name to add to the logger.</param>
<param name="parameterValue">
<attribution license="cc4" from="Microsoft" modified="false" />The parameter value to assign to the <paramref name="parameterName" />.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildFinishedHandler">
<MemberSignature Language="C#" Value="public void BuildFinishedHandler (object sender, Microsoft.Build.Framework.BuildFinishedEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.BuildFinishedEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.BuildFinished" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="BuildStartedHandler">
<MemberSignature Language="C#" Value="public void BuildStartedHandler (object sender, Microsoft.Build.Framework.BuildStartedEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.BuildStartedEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.BuildStarted" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CustomEventHandler">
<MemberSignature Language="C#" Value="public void CustomEventHandler (object sender, Microsoft.Build.Framework.CustomBuildEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.CustomBuildEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.CustomEventRaised" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ErrorHandler">
<MemberSignature Language="C#" Value="public void ErrorHandler (object sender, Microsoft.Build.Framework.BuildErrorEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.BuildErrorEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.ErrorRaised" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public virtual 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>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Registers the logger for the specified events.</para>
</summary>
<param name="eventSource">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.Framework.IEventSource" /> to register with the logger.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MessageHandler">
<MemberSignature Language="C#" Value="public void MessageHandler (object sender, Microsoft.Build.Framework.BuildMessageEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.BuildMessageEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.MessageRaised" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parameters">
<MemberSignature Language="C#" Value="public string Parameters { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</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 or sets the parameters passed to the <see cref="T:Microsoft.Build.BuildEngine.ConsoleLogger" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ProjectFinishedHandler">
<MemberSignature Language="C#" Value="public void ProjectFinishedHandler (object sender, Microsoft.Build.Framework.ProjectFinishedEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.ProjectFinishedEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.ProjectFinished" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ProjectStartedHandler">
<MemberSignature Language="C#" Value="public void ProjectStartedHandler (object sender, Microsoft.Build.Framework.ProjectStartedEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.ProjectStartedEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.ProjectStarted" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ShowSummary">
<MemberSignature Language="C#" Value="public bool ShowSummary { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</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 or sets a value indicating whether the logger will display a summary of errors and warnings.</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>The default console logger does not need to release any resources. This method does nothing.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Stops the logger and releases all resources.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SkipProjectStartedText">
<MemberSignature Language="C#" Value="public bool SkipProjectStartedText { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</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 or sets a value indicating whether the logger will display messages when new projects are started during the build.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TargetFinishedHandler">
<MemberSignature Language="C#" Value="public void TargetFinishedHandler (object sender, Microsoft.Build.Framework.TargetFinishedEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.TargetFinishedEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.TargetFinished" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TargetStartedHandler">
<MemberSignature Language="C#" Value="public void TargetStartedHandler (object sender, Microsoft.Build.Framework.TargetStartedEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.TargetStartedEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.TargetStarted" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TaskFinishedHandler">
<MemberSignature Language="C#" Value="public void TaskFinishedHandler (object sender, Microsoft.Build.Framework.TaskFinishedEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.TaskFinishedEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.TaskFinished" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TaskStartedHandler">
<MemberSignature Language="C#" Value="public void TaskStartedHandler (object sender, Microsoft.Build.Framework.TaskStartedEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.TaskStartedEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.TaskStarted" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Verbosity">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.LoggerVerbosity Verbosity { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.LoggerVerbosity</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 or sets the <see cref="T:Microsoft.Build.Framework.LoggerVerbosity" /> level of the logger.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="WarningHandler">
<MemberSignature Language="C#" Value="public void WarningHandler (object sender, Microsoft.Build.Framework.BuildWarningEventArgs args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="args" Type="Microsoft.Build.Framework.BuildWarningEventArgs" />
</Parameters>
<Docs>
<param name="args">To be added.</param>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Handles the <see cref="E:Microsoft.Build.Framework.IEventSource.WarningRaised" /> event.</para>
</summary>
<param name="sender">
<attribution license="cc4" from="Microsoft" modified="false" />The source of the event.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="WriteHandler">
<MemberSignature Language="C#" Value="protected Microsoft.Build.BuildEngine.WriteHandler WriteHandler { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.BuildEngine.WriteHandler</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 or sets to the <see cref="T:Microsoft.Build.BuildEngine.WriteHandler" /> delegate for the <see cref="T:Microsoft.Build.BuildEngine.ConsoleLogger" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
Reference in New Issue View Git Blame Copy Permalink