main
1<?xml version="1.0"?>
2<doc>
3 <assembly>
4 <name>JetBrains.Annotations</name>
5 </assembly>
6 <members>
7 <member name="T:JetBrains.Annotations.StringFormatMethodAttribute">
8 <summary>
9 Indicates that marked method builds string by format pattern and (optional) arguments.
10 Parameter, which contains format string, should be given in constructor.
11 The format string should be in <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> -like form
12 </summary>
13 </member>
14 <member name="M:JetBrains.Annotations.StringFormatMethodAttribute.#ctor(System.String)">
15 <summary>
16 Initializes new instance of StringFormatMethodAttribute
17 </summary>
18 <param name="formatParameterName">Specifies which parameter of an annotated method should be treated as format-string</param>
19 </member>
20 <member name="P:JetBrains.Annotations.StringFormatMethodAttribute.FormatParameterName">
21 <summary>
22 Gets format parameter name
23 </summary>
24 </member>
25 <member name="T:JetBrains.Annotations.InvokerParameterNameAttribute">
26 <summary>
27 Indicates that the function argument should be string literal and match one of the parameters of the caller function.
28 For example, <see cref="T:System.ArgumentNullException"/> has such parameter.
29 </summary>
30 </member>
31 <member name="T:JetBrains.Annotations.AssertionMethodAttribute">
32 <summary>
33 Indicates that the marked method is assertion method, i.e. it halts control flow if one of the conditions is satisfied.
34 To set the condition, mark one of the parameters with <see cref="T:JetBrains.Annotations.AssertionConditionAttribute"/> attribute
35 </summary>
36 <seealso cref="T:JetBrains.Annotations.AssertionConditionAttribute"/>
37 </member>
38 <member name="T:JetBrains.Annotations.AssertionConditionAttribute">
39 <summary>
40 Indicates the condition parameter of the assertion method.
41 The method itself should be marked by <see cref="T:JetBrains.Annotations.AssertionMethodAttribute"/> attribute.
42 The mandatory argument of the attribute is the assertion type.
43 </summary>
44 <seealso cref="T:JetBrains.Annotations.AssertionConditionType"/>
45 </member>
46 <member name="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
47 <summary>
48 Initializes new instance of AssertionConditionAttribute
49 </summary>
50 <param name="conditionType">Specifies condition type</param>
51 </member>
52 <member name="P:JetBrains.Annotations.AssertionConditionAttribute.ConditionType">
53 <summary>
54 Gets condition type
55 </summary>
56 </member>
57 <member name="T:JetBrains.Annotations.AssertionConditionType">
58 <summary>
59 Specifies assertion type. If the assertion method argument satisifes the condition, then the execution continues.
60 Otherwise, execution is assumed to be halted
61 </summary>
62 </member>
63 <member name="F:JetBrains.Annotations.AssertionConditionType.IS_TRUE">
64 <summary>
65 Indicates that the marked parameter should be evaluated to true
66 </summary>
67 </member>
68 <member name="F:JetBrains.Annotations.AssertionConditionType.IS_FALSE">
69 <summary>
70 Indicates that the marked parameter should be evaluated to false
71 </summary>
72 </member>
73 <member name="F:JetBrains.Annotations.AssertionConditionType.IS_NULL">
74 <summary>
75 Indicates that the marked parameter should be evaluated to null value
76 </summary>
77 </member>
78 <member name="F:JetBrains.Annotations.AssertionConditionType.IS_NOT_NULL">
79 <summary>
80 Indicates that the marked parameter should be evaluated to not null value
81 </summary>
82 </member>
83 <member name="T:JetBrains.Annotations.TerminatesProgramAttribute">
84 <summary>
85 Indicates that the marked method unconditionally terminates control flow execution.
86 For example, it could unconditionally throw exception
87 </summary>
88 </member>
89 <member name="T:JetBrains.Annotations.CanBeNullAttribute">
90 <summary>
91 Indicates that the value of marked element could be <c>null</c> sometimes, so the check for <c>null</c> is necessary before its usage
92 </summary>
93 </member>
94 <member name="T:JetBrains.Annotations.NotNullAttribute">
95 <summary>
96 Indicates that the value of marked element could never be <c>null</c>
97 </summary>
98 </member>
99 <member name="T:JetBrains.Annotations.CannotApplyEqualityOperatorAttribute">
100 <summary>
101 Indicates that the value of marked type (or its derivatives) cannot be compared using '==' or '!=' operators.
102 There is only exception to compare with <c>null</c>, it is permitted
103 </summary>
104 </member>
105 <member name="T:JetBrains.Annotations.BaseTypeRequiredAttribute">
106 <summary>
107 When applied to target attribute, specifies a requirement for any type which is marked with
108 target attribute to implement or inherit specific type or types
109 </summary>
110 <example>
111 <code>
112 [BaseTypeRequired(typeof(IComponent)] // Specify requirement
113 public class ComponentAttribute : Attribute
114 {}
115
116 [Component] // ComponentAttribute requires implementing IComponent interface
117 public class MyComponent : IComponent
118 {}
119 </code>
120 </example>
121 </member>
122 <member name="M:JetBrains.Annotations.BaseTypeRequiredAttribute.#ctor(System.Type[])">
123 <summary>
124 Initializes new instance of BaseTypeRequiredAttribute
125 </summary>
126 <param name="baseTypes">Specifies which types are required</param>
127 </member>
128 <member name="P:JetBrains.Annotations.BaseTypeRequiredAttribute.BaseTypes">
129 <summary>
130 Gets enumerations of specified base types
131 </summary>
132 </member>
133 <member name="T:JetBrains.Annotations.UsedImplicitlyAttribute">
134 <summary>
135 Indicates that the marked symbol is used implicitly (ex. reflection, external library), so this symbol will not be marked as unused (as well as by other usage inspections)
136 </summary>
137 </member>
138 <member name="T:JetBrains.Annotations.MeansImplicitUseAttribute">
139 <summary>
140 Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes as unused (as well as by other usage inspections)
141 </summary>
142 </member>
143 </members>
144</doc>