Annotations.cs File Reference

Classes
class	JetBrains.Annotations.CanBeNullAttribute
	Indicates that the value of the marked element could be null sometimes, so checking for null is required before its usage.
class	JetBrains.Annotations.NotNullAttribute
	Indicates that the value of the marked element can never be null.
class	JetBrains.Annotations.ItemNotNullAttribute
	Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task and Lazy classes to indicate that the value of a collection item, of the Task.Result property or of the Lazy.Value property can never be null.
class	JetBrains.Annotations.ItemCanBeNullAttribute
	Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task and Lazy classes to indicate that the value of a collection item, of the Task.Result property or of the Lazy.Value property can be null.
class	JetBrains.Annotations.StringFormatMethodAttribute
	Indicates that the marked method builds string by the format pattern and (optional) arguments. The parameter, which contains the format string, should be given in the constructor. The format string should be in string.Format(IFormatProvider,string,object[])-like form.
class	JetBrains.Annotations.StructuredMessageTemplateAttribute
	Indicates that the marked parameter is a message template where placeholders are to be replaced by the following arguments in the order in which they appear
class	JetBrains.Annotations.ValueProviderAttribute
	Use this annotation to specify a type that contains static or const fields with values for the annotated property/field/parameter. The specified type will be used to improve completion suggestions.
class	JetBrains.Annotations.ValueRangeAttribute
	Indicates that the integral value falls into the specified interval. It's allowed to specify multiple non-intersecting intervals. Values of interval boundaries are inclusive.
class	JetBrains.Annotations.NonNegativeValueAttribute
	Indicates that the integral value never falls below zero.
class	JetBrains.Annotations.InvokerParameterNameAttribute
	Indicates that the function argument should be a string literal and match one of the parameters of the caller function. This annotation is used for paramerers like 'string paramName' parameter of the System.ArgumentNullException constuctor.
class	JetBrains.Annotations.NotifyPropertyChangedInvocatorAttribute
	Indicates that the method is contained in a type that implements System.ComponentModel.INotifyPropertyChanged interface and this method is used to notify that some property value changed.
class	JetBrains.Annotations.ContractAnnotationAttribute
	Describes dependency between method input and output.
class	JetBrains.Annotations.LocalizationRequiredAttribute
	Indicates whether the marked element should be localized.
class	JetBrains.Annotations.CannotApplyEqualityOperatorAttribute
	Indicates that the value of the marked type (or its derivatives) cannot be compared using '==' or '!=' operators and Equals() should be used instead. However, using '==' or '!=' for comparison with null is always permitted.
class	JetBrains.Annotations.BaseTypeRequiredAttribute
	When applied to a target attribute, specifies a requirement for any type marked with the target attribute to implement or inherit specific type or types.
class	JetBrains.Annotations.UsedImplicitlyAttribute
	Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), so this symbol will be ignored by usage-checking inspections. You can use ImplicitUseKindFlags and ImplicitUseTargetFlags to configure how this attribute is applied.
class	JetBrains.Annotations.MeansImplicitUseAttribute
	Can be applied to attributes, type parameters, and parameters of a type assignable from System.Type . When applied to an attribute, the decorated attribute behaves the same as UsedImplicitlyAttribute. When applied to a type parameter or to a parameter of type System.Type, indicates that the corresponding type is used implicitly.
class	JetBrains.Annotations.PublicAPIAttribute
	This attribute is intended to mark publicly available API, which should not be removed and so is treated as used.
class	JetBrains.Annotations.InstantHandleAttribute
	Tells the code analysis engine if the parameter is completely handled when the invoked method is on stack. If the parameter is a delegate, indicates that delegate can only be invoked during method execution (the delegate can be invoked zero or multiple times, but not stored to some field and invoked later, when the containing method is no longer on the execution stack). If the parameter is an enumerable, indicates that it is enumerated while the method is executed. If RequireAwait is true, the attribute will only takes effect if the method invocation is located under the 'await' expression.
class	JetBrains.Annotations.PureAttribute
	Indicates that a method does not make any observable state changes. The same as System.Diagnostics.Contracts.PureAttribute.
class	JetBrains.Annotations.MustUseReturnValueAttribute
	Indicates that the return value of the method invocation must be used.
class	JetBrains.Annotations.RequireStaticDelegateAttribute
	This annotation allows to enforce allocation-less usage patterns of delegates for performance-critical APIs. When this annotation is applied to the parameter of delegate type, IDE checks the input argument of this parameter:
class	JetBrains.Annotations.ProvidesContextAttribute
	Indicates the type member or parameter of some type, that should be used instead of all other ways to get the value of that type. This annotation is useful when you have some "context" value evaluated and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one.
class	JetBrains.Annotations.PathReferenceAttribute
	Indicates that a parameter is a path to a file or a folder within a web project. Path can be relative or absolute, starting from web root (~).
class	JetBrains.Annotations.SourceTemplateAttribute
	An extension method marked with this attribute is processed by code completion as a 'Source Template'. When the extension method is completed over some expression, its source code is automatically expanded like a template at call site.
class	JetBrains.Annotations.MacroAttribute
	Allows specifying a macro for a parameter of a source template.
class	JetBrains.Annotations.CollectionAccessAttribute
	Indicates how method, constructor invocation, or property access over collection type affects the contents of the collection. When applied to a return value of a method indicates if the returned collection is created exclusively for the caller (CollectionAccessType.UpdatedContent) or can be read/updated from outside (CollectionAccessType.Read | CollectionAccessType.UpdatedContent) Use CollectionAccessType to specify the access type.
class	JetBrains.Annotations.AssertionMethodAttribute
	Indicates that the marked method is assertion method, i.e. it halts the control flow if one of the conditions is satisfied. To set the condition, mark one of the parameters with AssertionConditionAttribute attribute.
class	JetBrains.Annotations.AssertionConditionAttribute
	Indicates the condition parameter of the assertion method. The method itself should be marked by AssertionMethodAttribute attribute. The mandatory argument of the attribute is the assertion type.
class	JetBrains.Annotations.TerminatesProgramAttribute
	Indicates that the marked method unconditionally terminates control flow execution. For example, it could unconditionally throw exception.
class	JetBrains.Annotations.LinqTunnelAttribute
	Indicates that the method is a pure LINQ method, with postponed enumeration (like Enumerable.Select, .Where). This annotation allows inference of [InstantHandle] annotation for parameters of delegate type by analyzing LINQ method chains.
class	JetBrains.Annotations.NoEnumerationAttribute
	Indicates that IEnumerable passed as a parameter is not enumerated. Use this annotation to suppress the 'Possible multiple enumeration of IEnumerable' inspection.
class	JetBrains.Annotations.RegexPatternAttribute
	Indicates that the marked parameter, field, or property is a regular expression pattern.
class	JetBrains.Annotations.LanguageInjectionAttribute
	Indicates that the marked parameter, field, or property is accepting a string literal containing code fragment in a language specified by the InjectedLanguage.
class	JetBrains.Annotations.NoReorderAttribute
	Prevents the Member Reordering feature from tossing members of the marked class.
class	JetBrains.Annotations.CodeTemplateAttribute
class	JetBrains.Annotations.AspChildControlTypeAttribute
class	JetBrains.Annotations.AspDataFieldAttribute
class	JetBrains.Annotations.AspDataFieldsAttribute
class	JetBrains.Annotations.AspMethodPropertyAttribute
class	JetBrains.Annotations.AspRequiredAttributeAttribute
class	JetBrains.Annotations.AspTypePropertyAttribute
class	JetBrains.Annotations.AspMvcAreaMasterLocationFormatAttribute
class	JetBrains.Annotations.AspMvcAreaPartialViewLocationFormatAttribute
class	JetBrains.Annotations.AspMvcAreaViewLocationFormatAttribute
class	JetBrains.Annotations.AspMvcMasterLocationFormatAttribute
class	JetBrains.Annotations.AspMvcPartialViewLocationFormatAttribute
class	JetBrains.Annotations.AspMvcViewLocationFormatAttribute
class	JetBrains.Annotations.AspMvcActionAttribute
	ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC action. If applied to a method, the MVC action name is calculated implicitly from the context. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String).
class	JetBrains.Annotations.AspMvcAreaAttribute
	ASP.NET MVC attribute. Indicates that the marked parameter is an MVC area. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String).
class	JetBrains.Annotations.AspMvcControllerAttribute
	ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC controller. If applied to a method, the MVC controller name is calculated implicitly from the context. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String).
class	JetBrains.Annotations.AspMvcMasterAttribute
	ASP.NET MVC attribute. Indicates that the marked parameter is an MVC Master. Use this attribute for custom wrappers similar to System.Web.Mvc.Controller.View(String, String).
class	JetBrains.Annotations.AspMvcModelTypeAttribute
	ASP.NET MVC attribute. Indicates that the marked parameter is an MVC model type. Use this attribute for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object).
class	JetBrains.Annotations.AspMvcPartialViewAttribute
	ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC partial view. If applied to a method, the MVC partial view name is calculated implicitly from the context. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String).
class	JetBrains.Annotations.AspMvcSuppressViewErrorAttribute
	ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method.
class	JetBrains.Annotations.AspMvcDisplayTemplateAttribute
	ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String).
class	JetBrains.Annotations.AspMvcEditorTemplateAttribute
	ASP.NET MVC attribute. Indicates that the marked parameter is an MVC editor template. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String).
class	JetBrains.Annotations.AspMvcTemplateAttribute
	ASP.NET MVC attribute. Indicates that the marked parameter is an MVC template. Use this attribute for custom wrappers similar to System.ComponentModel.DataAnnotations.UIHintAttribute(System.String).
class	JetBrains.Annotations.AspMvcViewAttribute
	ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC view component. If applied to a method, the MVC view name is calculated implicitly from the context. Use this attribute for custom wrappers similar to System.Web.Mvc.Controller.View(Object).
class	JetBrains.Annotations.AspMvcViewComponentAttribute
	ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC view component name.
class	JetBrains.Annotations.AspMvcViewComponentViewAttribute
	ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC view component view. If applied to a method, the MVC view component view name is default.
class	JetBrains.Annotations.AspMvcActionSelectorAttribute
	ASP.NET MVC attribute. When applied to a parameter of an attribute, indicates that this parameter is an MVC action name.
class	JetBrains.Annotations.RouteTemplateAttribute
	Indicates that the marked parameter, field, or property is a route template.
class	JetBrains.Annotations.RouteParameterConstraintAttribute
	Indicates that the marked type is custom route parameter constraint, which is registered in application's Startup with name ConstraintName
class	JetBrains.Annotations.UriStringAttribute
	Indicates that the marked parameter, field, or property is an URI string.
class	JetBrains.Annotations.AspRouteConventionAttribute
	Indicates that the marked method declares routing convention for ASP.NET
class	JetBrains.Annotations.AspDefaultRouteValuesAttribute
	Indicates that the marked method parameter contains default route values of routing convention for ASP.NET
class	JetBrains.Annotations.AspRouteValuesConstraintsAttribute
	Indicates that the marked method parameter contains constraints on route values of routing convention for ASP.NET
class	JetBrains.Annotations.AspRouteOrderAttribute
	Indicates that the marked parameter or property contains routing order provided by ASP.NET routing attribute
class	JetBrains.Annotations.AspRouteVerbsAttribute
	Indicates that the marked parameter or property contains HTTP verbs provided by ASP.NET routing attribute
class	JetBrains.Annotations.AspAttributeRoutingAttribute
	Indicates that the marked attribute is used for attribute routing in ASP.NET
class	JetBrains.Annotations.AspMinimalApiDeclarationAttribute
	Indicates that the marked method declares ASP.NET Minimal API endpoint
class	JetBrains.Annotations.AspMinimalApiHandlerAttribute
	Indicates that the marked parameter contains ASP.NET Minimal API endpoint handler
class	JetBrains.Annotations.HtmlElementAttributesAttribute
class	JetBrains.Annotations.HtmlAttributeValueAttribute
class	JetBrains.Annotations.RazorSectionAttribute
	Razor attribute. Indicates that the marked parameter or method is a Razor section. Use this attribute for custom wrappers similar to System.Web.WebPages.WebPageBase.RenderSection(String).
class	JetBrains.Annotations.RazorImportNamespaceAttribute
class	JetBrains.Annotations.RazorInjectionAttribute
class	JetBrains.Annotations.RazorDirectiveAttribute
class	JetBrains.Annotations.RazorPageBaseTypeAttribute
class	JetBrains.Annotations.RazorHelperCommonAttribute
class	JetBrains.Annotations.RazorLayoutAttribute
class	JetBrains.Annotations.RazorWriteLiteralMethodAttribute
class	JetBrains.Annotations.RazorWriteMethodAttribute
class	JetBrains.Annotations.RazorWriteMethodParameterAttribute
class	JetBrains.Annotations.XamlItemsControlAttribute
	XAML attribute. Indicates the type that has ItemsSource property and should be treated as ItemsControl-derived type, to enable inner items DataContext type resolve.
class	JetBrains.Annotations.XamlItemBindingOfItemsControlAttribute
	XAML attribute. Indicates the property of some BindingBase-derived type, that is used to bind some item of ItemsControl-derived type. This annotation will enable the DataContext type resolve for XAML bindings for such properties.
class	JetBrains.Annotations.XamlItemStyleOfItemsControlAttribute
	XAML attribute. Indicates the property of some Style-derived type, that is used to style items of ItemsControl-derived type. This annotation will enable the DataContext type resolve for XAML bindings for such properties.
class	JetBrains.Annotations.XamlOneWayBindingModeByDefaultAttribute
	XAML attribute. Indicates that DependencyProperty has OneWay binding mode by default.
class	JetBrains.Annotations.XamlTwoWayBindingModeByDefaultAttribute
	XAML attribute. Indicates that DependencyProperty has TwoWay binding mode by default.

Namespaces
namespace	JetBrains
namespace	JetBrains.Annotations