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

211
mcs/class/corlib/Documentation/en/System.Diagnostics.CodeAnalysis/SuppressMessageAttribute.xml Normal file
View File

@@ -0,0 +1,211 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SuppressMessageAttribute" FullName="System.Diagnostics.CodeAnalysis.SuppressMessageAttribute">
<TypeSignature Language="C#" Value="public sealed class SuppressMessageAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SuppressMessageAttribute extends System.Attribute" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=true, Inherited=false)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Diagnostics.Conditional("CODE_ANALYSIS")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This attribute can be applied to any application element. For a complete list of the violations that can be suppressed, see <format type="text/html"><a href="3c2741ff-0d3a-42e6-acd5-d42310bd03c4">Code Analysis for Managed Code Warnings</a></format>.</para>
<block subset="none" type="note">
<para>The <see cref="T:System.Diagnostics.ConditionalAttribute" /> is applied to this class, specifying the preprocessing symbol "CODE_ANALYSIS" as the conditional symbol that determines whether the attribute call is included or omitted. If the symbol is defined, the attribute call is included; otherwise, the call is omitted.</para>
<para>When you right-click a Code Analysis warning in the Visual Studio <ui>Error List</ui> and then click <ui>Suppress Message(s)</ui>, a SuppressMessage attribute is added either in your code or to the project's global suppressions file. For more information about the SuppressMessage attribute and its use in Visual Studio, see <format type="text/html"><a href="f1a2dc6a-a9eb-408c-9078-2571e57d207d">In Source Suppression Overview</a></format>.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Suppresses reporting of a specific static analysis tool rule violation, allowing multiple suppressions on a single code artifact.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SuppressMessageAttribute (string category, string checkId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string category, string checkId) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="category" Type="System.String" />
<Parameter Name="checkId" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <paramref name="category" /> parameter value is specific to the analysis tool and categorizes the rule identified by the <paramref name="checkId" /> parameter. The two parameters concatenated together form a unique identifier for the rule.</para>
<block subset="none" type="note">
<para>The preprocessor symbol "CODE_ANALYSIS" must be defined for this attribute to be effective. The absence of the preprocessor symbol results in the attribute not being applied.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute" /> class, specifying the category of the static analysis tool and the identifier for an analysis rule. </para>
</summary>
<param name="category">
<attribution license="cc4" from="Microsoft" modified="false" />The category for the attribute.</param>
<param name="checkId">
<attribution license="cc4" from="Microsoft" modified="false" />The identifier of the analysis tool rule the attribute applies to.</param>
</Docs>
</Member>
<Member MemberName="Category">
<MemberSignature Language="C#" Value="public string Category { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Category" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.Category" /> property describes the tool or tool analysis category for which a message suppression attribute applies.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the category identifying the classification of the attribute.</para>
</summary>
</Docs>
</Member>
<Member MemberName="CheckId">
<MemberSignature Language="C#" Value="public string CheckId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CheckId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.Category" /> and <see cref="P:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.CheckId" /> properties form a unique check identifier.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the identifier of the static analysis tool rule to be suppressed.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Justification">
<MemberSignature Language="C#" Value="public string Justification { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Justification" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the justification for suppressing the code analysis message.</para>
</summary>
</Docs>
</Member>
<Member MemberName="MessageId">
<MemberSignature Language="C#" Value="public string MessageId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MessageId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.MessageId" /> property is an optional argument that specifies additional exclusion where the literal metadata target is not sufficiently precise. For example, the <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute" /> cannot be applied within a method, and it may be desirable to suppress a violation against a statement in the method that will give a rule violation, but not against all statements in the method. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets an optional argument expanding on exclusion criteria.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Scope">
<MemberSignature Language="C#" Value="public string Scope { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Scope" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.Scope" /> property is an optional argument that specifies the metadata scope for which the attribute is relevant. Possible values for managed metadata include "member", "resource", "module", "type", "method", or "namespace".</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the scope of the code that is relevant for the attribute.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Target">
<MemberSignature Language="C#" Value="public string Target { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Target" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.Target" /> property is an optional argument identifying the analysis target of the attribute. An example value is "System.IO.Stream.ctor():System.Void". Because it is fully qualified, it can be long, particularly for targets such as parameters. The analysis tool user interface should be capable of automatically formatting the parameter. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a fully qualified path that represents the target of the attribute.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>