| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>JetBrains.Annotations</name>
- </assembly>
- <members>
- <member name="T:JetBrains.Annotations.CanBeNullAttribute">
- <summary>
- Indicates that the value of the marked element could be <c>null</c> sometimes,
- so checking for <c>null</c> is required before its usage.
- </summary>
- <example><code>
- [CanBeNull] object Test() => null;
-
- void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.NotNullAttribute">
- <summary>
- Indicates that the value of the marked element can never be <c>null</c>.
- </summary>
- <example><code>
- [NotNull] object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.ItemNotNullAttribute">
- <summary>
- 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.
- </summary>
- <example><code>
- public void Foo([ItemNotNull]List<string> books)
- {
- foreach (var book in books) {
- if (book != null) // Warning: Expression is always true
- Console.WriteLine(book.ToUpper());
- }
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.ItemCanBeNullAttribute">
- <summary>
- 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.
- </summary>
- <example><code>
- public void Foo([ItemCanBeNull]List<string> books)
- {
- foreach (var book in books)
- {
- // Warning: Possible 'System.NullReferenceException'
- Console.WriteLine(book.ToUpper());
- }
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.StringFormatMethodAttribute">
- <summary>
- 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 constructor. The format string
- should be in <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>-like form.
- </summary>
- <example><code>
- [StringFormatMethod("message")]
- void ShowError(string message, params object[] args) { /* do something */ }
-
- void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
- </code></example>
- </member>
- <member name="M:JetBrains.Annotations.StringFormatMethodAttribute.#ctor(System.String)">
- <param name="formatParameterName">
- Specifies which parameter of an annotated method should be treated as the format string
- </param>
- </member>
- <member name="T:JetBrains.Annotations.ValueProviderAttribute">
- <summary>
- 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.
- </summary>
- <example><code>
- namespace TestNamespace
- {
- public class Constants
- {
- public static int INT_CONST = 1;
- public const string STRING_CONST = "1";
- }
-
- public class Class1
- {
- [ValueProvider("TestNamespace.Constants")] public int myField;
- public void Foo([ValueProvider("TestNamespace.Constants")] string str) { }
-
- public void Test()
- {
- Foo(/*try completion here*/);//
- myField = /*try completion here*/
- }
- }
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.InvokerParameterNameAttribute">
- <summary>
- Indicates that the function argument should be a string literal and match one
- of the parameters of the caller function. For example, ReSharper annotates
- the parameter of <see cref="T:System.ArgumentNullException"/>.
- </summary>
- <example><code>
- void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.NotifyPropertyChangedInvocatorAttribute">
- <summary>
- Indicates that the method is contained in a type that implements
- <c>System.ComponentModel.INotifyPropertyChanged</c> interface and this method
- is used to notify that some property value changed.
- </summary>
- <remarks>
- The method should be non-static and conform to one of the supported signatures:
- <list>
- <item><c>NotifyChanged(string)</c></item>
- <item><c>NotifyChanged(params string[])</c></item>
- <item><c>NotifyChanged{T}(Expression{Func{T}})</c></item>
- <item><c>NotifyChanged{T,U}(Expression{Func{T,U}})</c></item>
- <item><c>SetProperty{T}(ref T, T, string)</c></item>
- </list>
- </remarks>
- <example><code>
- public class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
-
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- string _name;
-
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
- </code>
- Examples of generated notifications:
- <list>
- <item><c>NotifyChanged("Property")</c></item>
- <item><c>NotifyChanged(() => Property)</c></item>
- <item><c>NotifyChanged((VM x) => x.Property)</c></item>
- <item><c>SetProperty(ref myField, value, "Property")</c></item>
- </list>
- </example>
- </member>
- <member name="T:JetBrains.Annotations.ContractAnnotationAttribute">
- <summary>
- Describes dependency between method input and output.
- </summary>
- <syntax>
- <p>Function Definition Table syntax:</p>
- <list>
- <item>FDT ::= FDTRow [;FDTRow]*</item>
- <item>FDTRow ::= Input => Output | Output <= Input</item>
- <item>Input ::= ParameterName: Value [, Input]*</item>
- <item>Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value}</item>
- <item>Value ::= true | false | null | notnull | canbenull</item>
- </list>
- If the method has a single input parameter, its name could be omitted.<br/>
- Using <c>halt</c> (or <c>void</c>/<c>nothing</c>, which is the same) for the method output
- means that the method doesn't return normally (throws or terminates the process).<br/>
- Value <c>canbenull</c> is only applicable for output parameters.<br/>
- You can use multiple <c>[ContractAnnotation]</c> for each FDT row, or use single attribute
- with rows separated by semicolon. There is no notion of order rows, all rows are checked
- for applicability and applied per each program state tracked by the analysis engine.<br/>
- </syntax>
- <examples><list>
- <item><code>
- [ContractAnnotation("=> halt")]
- public void TerminationMethod()
- </code></item>
- <item><code>
- [ContractAnnotation("null <= param:null")] // reverse condition syntax
- public string GetName(string surname)
- </code></item>
- <item><code>
- [ContractAnnotation("s:null => true")]
- public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty()
- </code></item>
- <item><code>
- // A method that returns null if the parameter is null,
- // and not null if the parameter is not null
- [ContractAnnotation("null => null; notnull => notnull")]
- public object Transform(object data)
- </code></item>
- <item><code>
- [ContractAnnotation("=> true, result: notnull; => false, result: null")]
- public bool TryParse(string s, out Person result)
- </code></item>
- </list></examples>
- </member>
- <member name="T:JetBrains.Annotations.LocalizationRequiredAttribute">
- <summary>
- Indicates whether the marked element should be localized.
- </summary>
- <example><code>
- [LocalizationRequiredAttribute(true)]
- class Foo {
- string str = "my string"; // Warning: Localizable string
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.CannotApplyEqualityOperatorAttribute">
- <summary>
- Indicates that the value of the marked type (or its derivatives)
- cannot be compared using '==' or '!=' operators and <c>Equals()</c>
- should be used instead. However, using '==' or '!=' for comparison
- with <c>null</c> is always permitted.
- </summary>
- <example><code>
- [CannotApplyEqualityOperator]
- class NoEquality { }
-
- class UsesNoEquality {
- void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.BaseTypeRequiredAttribute">
- <summary>
- 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.
- </summary>
- <example><code>
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- class ComponentAttribute : Attribute { }
-
- [Component] // ComponentAttribute requires implementing IComponent interface
- class MyComponent : IComponent { }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.UsedImplicitlyAttribute">
- <summary>
- Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library),
- so this symbol will not be reported as unused (as well as by other usage inspections).
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.MeansImplicitUseAttribute">
- <summary>
- Can be applied to attributes, type parameters, and parameters of a type assignable from <see cref="T:System.Type"/> .
- When applied to an attribute, the decorated attribute behaves the same as <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
- When applied to a type parameter or to a parameter of type <see cref="T:System.Type"/>, indicates that the corresponding type
- is used implicitly.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.ImplicitUseKindFlags">
- <summary>
- Specify the details of implicitly used symbol when it is marked
- with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
- </summary>
- </member>
- <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Access">
- <summary>Only entity marked with attribute considered used.</summary>
- </member>
- <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Assign">
- <summary>Indicates implicit assignment to a member.</summary>
- </member>
- <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature">
- <summary>
- Indicates implicit instantiation of a type with fixed constructor signature.
- That means any unused constructor parameters won't be reported as such.
- </summary>
- </member>
- <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature">
- <summary>Indicates implicit instantiation of a type.</summary>
- </member>
- <member name="T:JetBrains.Annotations.ImplicitUseTargetFlags">
- <summary>
- Specify what is considered to be used implicitly when marked
- with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>.
- </summary>
- </member>
- <member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.Members">
- <summary>Members of entity marked with attribute are considered used.</summary>
- </member>
- <member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithMembers">
- <summary>Entity marked with attribute and all its members considered used.</summary>
- </member>
- <member name="T:JetBrains.Annotations.PublicAPIAttribute">
- <summary>
- This attribute is intended to mark publicly available API
- which should not be removed and so is treated as used.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.InstantHandleAttribute">
- <summary>
- Tells 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 is executed while the method is executed.
- If the parameter is an enumerable, indicates that it is enumerated while the method is executed.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.PureAttribute">
- <summary>
- Indicates that a method does not make any observable state changes.
- The same as <c>System.Diagnostics.Contracts.PureAttribute</c>.
- </summary>
- <example><code>
- [Pure] int Multiply(int x, int y) => x * y;
-
- void M() {
- Multiply(123, 42); // Waring: Return value of pure method is not used
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.MustUseReturnValueAttribute">
- <summary>
- Indicates that the return value of the method invocation must be used.
- </summary>
- <remarks>
- Methods decorated with this attribute (in contrast to pure methods) might change state,
- but make no sense without using their return value. <br/>
- Similarly to <see cref="T:JetBrains.Annotations.PureAttribute"/>, this attribute
- will help detecting usages of the method when the return value in not used.
- Additionally, you can optionally specify a custom message, which will be used when showing warnings, e.g.
- <code>[MustUseReturnValue("Use the return value to...")]</code>.
- </remarks>
- </member>
- <member name="T:JetBrains.Annotations.ProvidesContextAttribute">
- <summary>
- 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.
- </summary>
- <example><code>
- class Foo {
- [ProvidesContext] IBarService _barService = ...;
-
- void ProcessNode(INode node) {
- DoSomething(node, node.GetGlobalServices().Bar);
- // ^ Warning: use value of '_barService' field
- }
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.PathReferenceAttribute">
- <summary>
- 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 (~).
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.SourceTemplateAttribute">
- <summary>
- 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.
- </summary>
- <remarks>
- Template method body can contain valid source code and/or special comments starting with '$'.
- Text inside these comments is added as source code when the template is applied. Template parameters
- can be used either as additional method parameters or as identifiers wrapped in two '$' signs.
- Use the <see cref="T:JetBrains.Annotations.MacroAttribute"/> attribute to specify macros for parameters.
- </remarks>
- <example>
- In this example, the 'forEach' method is a source template available over all values
- of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block:
- <code>
- [SourceTemplate]
- public static void forEach<T>(this IEnumerable<T> xs) {
- foreach (var x in xs) {
- //$ $END$
- }
- }
- </code>
- </example>
- </member>
- <member name="T:JetBrains.Annotations.MacroAttribute">
- <summary>
- Allows specifying a macro for a parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>.
- </summary>
- <remarks>
- You can apply the attribute on the whole method or on any of its additional parameters. The macro expression
- is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Expression"/> property. When applied on a method, the target
- template parameter is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Target"/> property. To apply the macro silently
- for the parameter, set the <see cref="P:JetBrains.Annotations.MacroAttribute.Editable"/> property value = -1.
- </remarks>
- <example>
- Applying the attribute on a source template method:
- <code>
- [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")]
- public static void forEach<T>(this IEnumerable<T> collection) {
- foreach (var item in collection) {
- //$ $END$
- }
- }
- </code>
- Applying the attribute on a template method parameter:
- <code>
- [SourceTemplate]
- public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) {
- /*$ var $x$Id = "$newguid$" + x.ToString();
- x.DoSomething($x$Id); */
- }
- </code>
- </example>
- </member>
- <member name="P:JetBrains.Annotations.MacroAttribute.Expression">
- <summary>
- Allows specifying a macro that will be executed for a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>
- parameter when the template is expanded.
- </summary>
- </member>
- <member name="P:JetBrains.Annotations.MacroAttribute.Editable">
- <summary>
- Allows specifying which occurrence of the target parameter becomes editable when the template is deployed.
- </summary>
- <remarks>
- If the target parameter is used several times in the template, only one occurrence becomes editable;
- other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence,
- use values >= 0. To make the parameter non-editable when the template is expanded, use -1.
- </remarks>
- </member>
- <member name="P:JetBrains.Annotations.MacroAttribute.Target">
- <summary>
- Identifies the target parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see> if the
- <see cref="T:JetBrains.Annotations.MacroAttribute"/> is applied on a template method.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcActionAttribute">
- <summary>
- 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
- <c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcAreaAttribute">
- <summary>
- ASP.NET MVC attribute. Indicates that the marked parameter is an MVC area.
- Use this attribute for custom wrappers similar to
- <c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcControllerAttribute">
- <summary>
- 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
- <c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcMasterAttribute">
- <summary>
- ASP.NET MVC attribute. Indicates that the marked parameter is an MVC Master. Use this attribute
- for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, String)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcModelTypeAttribute">
- <summary>
- ASP.NET MVC attribute. Indicates that the marked parameter is an MVC model type. Use this attribute
- for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, Object)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcPartialViewAttribute">
- <summary>
- 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
- <c>System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcSuppressViewErrorAttribute">
- <summary>
- ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcDisplayTemplateAttribute">
- <summary>
- ASP.NET MVC attribute. Indicates that a parameter is an MVC display template.
- Use this attribute for custom wrappers similar to
- <c>System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcEditorTemplateAttribute">
- <summary>
- ASP.NET MVC attribute. Indicates that the marked parameter is an MVC editor template.
- Use this attribute for custom wrappers similar to
- <c>System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcTemplateAttribute">
- <summary>
- ASP.NET MVC attribute. Indicates that the marked parameter is an MVC template.
- Use this attribute for custom wrappers similar to
- <c>System.ComponentModel.DataAnnotations.UIHintAttribute(System.String)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcViewAttribute">
- <summary>
- 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
- <c>System.Web.Mvc.Controller.View(Object)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcViewComponentAttribute">
- <summary>
- ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
- is an MVC view component name.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcViewComponentViewAttribute">
- <summary>
- 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.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AspMvcActionSelectorAttribute">
- <summary>
- ASP.NET MVC attribute. When applied to a parameter of an attribute,
- indicates that this parameter is an MVC action name.
- </summary>
- <example><code>
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.RazorSectionAttribute">
- <summary>
- Razor attribute. Indicates that the marked parameter or method is a Razor section.
- Use this attribute for custom wrappers similar to
- <c>System.Web.WebPages.WebPageBase.RenderSection(String)</c>.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.CollectionAccessAttribute">
- <summary>
- Indicates how method, constructor invocation, or property access
- over collection type affects the contents of the collection.
- Use <see cref="P:JetBrains.Annotations.CollectionAccessAttribute.CollectionAccessType"/> to specify the access type.
- </summary>
- <remarks>
- Using this attribute only makes sense if all collection methods are marked with this attribute.
- </remarks>
- <example><code>
- public class MyStringCollection : List<string>
- {
- [CollectionAccess(CollectionAccessType.Read)]
- public string GetFirstString()
- {
- return this.ElementAt(0);
- }
- }
- class Test
- {
- public void Foo()
- {
- // Warning: Contents of the collection is never updated
- var col = new MyStringCollection();
- string x = col.GetFirstString();
- }
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.CollectionAccessType">
- <summary>
- Provides a value for the <see cref="T:JetBrains.Annotations.CollectionAccessAttribute"/> to define
- how the collection method invocation affects the contents of the collection.
- </summary>
- </member>
- <member name="F:JetBrains.Annotations.CollectionAccessType.None">
- <summary>Method does not use or modify content of the collection.</summary>
- </member>
- <member name="F:JetBrains.Annotations.CollectionAccessType.Read">
- <summary>Method only reads content of the collection but does not modify it.</summary>
- </member>
- <member name="F:JetBrains.Annotations.CollectionAccessType.ModifyExistingContent">
- <summary>Method can change content of the collection but does not add new elements.</summary>
- </member>
- <member name="F:JetBrains.Annotations.CollectionAccessType.UpdatedContent">
- <summary>Method can add new elements to the collection.</summary>
- </member>
- <member name="T:JetBrains.Annotations.AssertionMethodAttribute">
- <summary>
- 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
- <see cref="T:JetBrains.Annotations.AssertionConditionAttribute"/> attribute.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AssertionConditionAttribute">
- <summary>
- Indicates the condition parameter of the assertion method. The method itself should be
- marked by <see cref="T:JetBrains.Annotations.AssertionMethodAttribute"/> attribute. The mandatory argument of
- the attribute is the assertion type.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.AssertionConditionType">
- <summary>
- Specifies assertion type. If the assertion method argument satisfies the condition,
- then the execution continues. Otherwise, execution is assumed to be halted.
- </summary>
- </member>
- <member name="F:JetBrains.Annotations.AssertionConditionType.IS_TRUE">
- <summary>Marked parameter should be evaluated to true.</summary>
- </member>
- <member name="F:JetBrains.Annotations.AssertionConditionType.IS_FALSE">
- <summary>Marked parameter should be evaluated to false.</summary>
- </member>
- <member name="F:JetBrains.Annotations.AssertionConditionType.IS_NULL">
- <summary>Marked parameter should be evaluated to null value.</summary>
- </member>
- <member name="F:JetBrains.Annotations.AssertionConditionType.IS_NOT_NULL">
- <summary>Marked parameter should be evaluated to not null value.</summary>
- </member>
- <member name="T:JetBrains.Annotations.TerminatesProgramAttribute">
- <summary>
- Indicates that the marked method unconditionally terminates control flow execution.
- For example, it could unconditionally throw exception.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.LinqTunnelAttribute">
- <summary>
- Indicates that method is 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.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.NoEnumerationAttribute">
- <summary>
- Indicates that IEnumerable passed as a parameter is not enumerated.
- Use this annotation to suppress the 'Possible multiple enumeration of IEnumerable' inspection.
- </summary>
- <example><code>
- static void ThrowIfNull<T>([NoEnumeration] T v, string n) where T : class
- {
- // custom check for null but no enumeration
- }
-
- void Foo(IEnumerable<string> values)
- {
- ThrowIfNull(values, nameof(values));
- var x = values.ToList(); // No warnings about multiple enumeration
- }
- </code></example>
- </member>
- <member name="T:JetBrains.Annotations.RegexPatternAttribute">
- <summary>
- Indicates that the marked parameter is a regular expression pattern.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.NoReorderAttribute">
- <summary>
- Prevents the Member Reordering feature from tossing members of the marked class.
- </summary>
- <remarks>
- The attribute must be mentioned in your member reordering patterns.
- </remarks>
- </member>
- <member name="T:JetBrains.Annotations.XamlItemsControlAttribute">
- <summary>
- XAML attribute. Indicates the type that has <c>ItemsSource</c> property and should be treated
- as <c>ItemsControl</c>-derived type, to enable inner items <c>DataContext</c> type resolve.
- </summary>
- </member>
- <member name="T:JetBrains.Annotations.XamlItemBindingOfItemsControlAttribute">
- <summary>
- XAML attribute. Indicates the property of some <c>BindingBase</c>-derived type, that
- is used to bind some item of <c>ItemsControl</c>-derived type. This annotation will
- enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
- </summary>
- <remarks>
- Property should have the tree ancestor of the <c>ItemsControl</c> type or
- marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute.
- </remarks>
- </member>
- </members>
- </doc>
|