NDoc User's Guide

NDoc 1.3

<threadsafety>

[This is preliminary documentation and subject to change]

The <threadsafety> tag is used to describe how a class or structure behaves in multi-threaded scenarios.

<threadsafety static="true|false" instance="true|false"/>

where:

static="true|false": indicates whether static member of this class are safe for multi-threaded operations.
instance="true|false": indicates whether members of instances of this type are safe for multi-threaded operations.

Applies To

Class, Structure.

Remarks

Examples

[C#]
/// <threadsafety static="true" instance="false"/>
public class MyClass
{
   /// not safe across threads
   public void InstanceMethod()
   {
   }
   
   /// safe across threads
   public static void StaticMethod()
   {
   }
}

See Also

Tag Usage | NDoc Tags