-
Notifications
You must be signed in to change notification settings - Fork 14
/
LoggerDescription.xml
220 lines (216 loc) · 14.6 KB
/
LoggerDescription.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<Type Name="LoggerDescription" FullName="Microsoft.Build.Logging.LoggerDescription">
<TypeSignature Language="C#" Value="public class LoggerDescription" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit LoggerDescription extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Build.Logging.LoggerDescription" />
<TypeSignature Language="VB.NET" Value="Public Class LoggerDescription" />
<TypeSignature Language="F#" Value="type LoggerDescription = class" />
<TypeSignature Language="C++ CLI" Value="public ref class LoggerDescription" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
This class is used to contain information about a logger as a collection of values that
can be used to instantiate the logger and can be serialized to be passed between different
processes.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public LoggerDescription (string loggerClassName, string loggerAssemblyName, string loggerAssemblyFile, string loggerSwitchParameters, Microsoft.Build.Framework.LoggerVerbosity verbosity);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string loggerClassName, string loggerAssemblyName, string loggerAssemblyFile, string loggerSwitchParameters, valuetype Microsoft.Build.Framework.LoggerVerbosity verbosity) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Logging.LoggerDescription.#ctor(System.String,System.String,System.String,System.String,Microsoft.Build.Framework.LoggerVerbosity)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (loggerClassName As String, loggerAssemblyName As String, loggerAssemblyFile As String, loggerSwitchParameters As String, verbosity As LoggerVerbosity)" />
<MemberSignature Language="F#" Value="new Microsoft.Build.Logging.LoggerDescription : string * string * string * string * Microsoft.Build.Framework.LoggerVerbosity -> Microsoft.Build.Logging.LoggerDescription" Usage="new Microsoft.Build.Logging.LoggerDescription (loggerClassName, loggerAssemblyName, loggerAssemblyFile, loggerSwitchParameters, verbosity)" />
<MemberSignature Language="C++ CLI" Value="public:
 LoggerDescription(System::String ^ loggerClassName, System::String ^ loggerAssemblyName, System::String ^ loggerAssemblyFile, System::String ^ loggerSwitchParameters, Microsoft::Build::Framework::LoggerVerbosity verbosity);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="loggerClassName" Type="System.String" />
<Parameter Name="loggerAssemblyName" Type="System.String" />
<Parameter Name="loggerAssemblyFile" Type="System.String" />
<Parameter Name="loggerSwitchParameters" Type="System.String" />
<Parameter Name="verbosity" Type="Microsoft.Build.Framework.LoggerVerbosity" />
</Parameters>
<Docs>
<param name="loggerClassName">The class name of the logger.</param>
<param name="loggerAssemblyName">The assembly name that implements the logger.</param>
<param name="loggerAssemblyFile">The assembly file that implements the logger.</param>
<param name="loggerSwitchParameters">Switch parameters for the logger.</param>
<param name="verbosity">The verbosity level.</param>
<summary>
Creates a logger description from given data
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public LoggerDescription (string loggerClassName, string loggerAssemblyName, string loggerAssemblyFile, string loggerSwitchParameters, Microsoft.Build.Framework.LoggerVerbosity verbosity, bool isOptional);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string loggerClassName, string loggerAssemblyName, string loggerAssemblyFile, string loggerSwitchParameters, valuetype Microsoft.Build.Framework.LoggerVerbosity verbosity, bool isOptional) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Logging.LoggerDescription.#ctor(System.String,System.String,System.String,System.String,Microsoft.Build.Framework.LoggerVerbosity,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (loggerClassName As String, loggerAssemblyName As String, loggerAssemblyFile As String, loggerSwitchParameters As String, verbosity As LoggerVerbosity, isOptional As Boolean)" />
<MemberSignature Language="F#" Value="new Microsoft.Build.Logging.LoggerDescription : string * string * string * string * Microsoft.Build.Framework.LoggerVerbosity * bool -> Microsoft.Build.Logging.LoggerDescription" Usage="new Microsoft.Build.Logging.LoggerDescription (loggerClassName, loggerAssemblyName, loggerAssemblyFile, loggerSwitchParameters, verbosity, isOptional)" />
<MemberSignature Language="C++ CLI" Value="public:
 LoggerDescription(System::String ^ loggerClassName, System::String ^ loggerAssemblyName, System::String ^ loggerAssemblyFile, System::String ^ loggerSwitchParameters, Microsoft::Build::Framework::LoggerVerbosity verbosity, bool isOptional);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="loggerClassName" Type="System.String" Index="0" FrameworkAlternate="msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore" />
<Parameter Name="loggerAssemblyName" Type="System.String" Index="1" FrameworkAlternate="msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore" />
<Parameter Name="loggerAssemblyFile" Type="System.String" Index="2" FrameworkAlternate="msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore" />
<Parameter Name="loggerSwitchParameters" Type="System.String" Index="3" FrameworkAlternate="msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore" />
<Parameter Name="verbosity" Type="Microsoft.Build.Framework.LoggerVerbosity" Index="4" FrameworkAlternate="msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore" />
<Parameter Name="isOptional" Type="System.Boolean" Index="5" FrameworkAlternate="msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore" />
</Parameters>
<Docs>
<param name="loggerClassName">To be added.</param>
<param name="loggerAssemblyName">To be added.</param>
<param name="loggerAssemblyFile">To be added.</param>
<param name="loggerSwitchParameters">To be added.</param>
<param name="verbosity">To be added.</param>
<param name="isOptional">To be added.</param>
<summary>
Creates a logger description from given data
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateLogger">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.ILogger CreateLogger ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Build.Framework.ILogger CreateLogger() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Logging.LoggerDescription.CreateLogger" />
<MemberSignature Language="VB.NET" Value="Public Function CreateLogger () As ILogger" />
<MemberSignature Language="F#" Value="member this.CreateLogger : unit -> Microsoft.Build.Framework.ILogger" Usage="loggerDescription.CreateLogger " />
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::Build::Framework::ILogger ^ CreateLogger();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.ILogger</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Create an ILogger out of the data in this description. This method may throw a variety of
reflection exceptions if the data is invalid. It is the resposibility of the caller to handle these
exceptions if desired.
</summary>
<returns />
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method may throw a variety of reflection exceptions if the data is invalid. It is the responsibility of the caller to handle these exceptions if desired.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IsOptional">
<MemberSignature Language="C#" Value="public bool IsOptional { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsOptional" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Logging.LoggerDescription.IsOptional" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsOptional As Boolean" />
<MemberSignature Language="F#" Value="member this.IsOptional : bool" Usage="Microsoft.Build.Logging.LoggerDescription.IsOptional" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsOptional { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LoggerSwitchParameters">
<MemberSignature Language="C#" Value="public string LoggerSwitchParameters { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string LoggerSwitchParameters" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Logging.LoggerDescription.LoggerSwitchParameters" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LoggerSwitchParameters As String" />
<MemberSignature Language="F#" Value="member this.LoggerSwitchParameters : string" Usage="Microsoft.Build.Logging.LoggerDescription.LoggerSwitchParameters" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ LoggerSwitchParameters { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns the string of logger parameters, null if there are none
</summary>
<value>The string of logger parameters, or <see langword="null" /> if there are no parameters.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Verbosity">
<MemberSignature Language="C#" Value="public Microsoft.Build.Framework.LoggerVerbosity Verbosity { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Build.Framework.LoggerVerbosity Verbosity" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Logging.LoggerDescription.Verbosity" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Verbosity As LoggerVerbosity" />
<MemberSignature Language="F#" Value="member this.Verbosity : Microsoft.Build.Framework.LoggerVerbosity" Usage="Microsoft.Build.Logging.LoggerDescription.Verbosity" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Build::Framework::LoggerVerbosity Verbosity { Microsoft::Build::Framework::LoggerVerbosity get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Build.Framework.LoggerVerbosity</ReturnType>
</ReturnValue>
<Docs>
<summary>
Return the verbosity for this logger (from command line all loggers get same verbosity)
</summary>
<value>To be added.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For command line display, all loggers get the same verbosity level.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>