The <platform> tag is a structured element that is used to specify the runtime environment that a particular type or member is supported on.

    <platform>
       <os predefined="all | nt5plus | enterprise">[custom list]</os>
       <frameworks>
          <compact>[true | false]</compact>
          <mono>[true | false]</mono>
          <custom>custom list</custom>
       </frameworks>
    </platform>

where:

predefined:

all
  Windows 98, Windows NT 4, Windows 2000, Windows XP Home and Pro, Windows 2003 Server
nt5plus
  Windows 2000, Windows XP Home and Pro, Windows 2003 Server
enterprise
Windows 2000, Windows XP Pro, Windows 2003 Server

custom list is a textual list of frameworks or operating system not included in the predefined sets

#### Applies To

All Types and Members.

#### Remarks

Platform is the combination of operating system and framework implementation.

The <os> tag is used to specify the operating system. The predefined attribute can be used to refer to the most common sets of operating system. The tag can also include a custom list of operating systems instead of, or in addition to, the predefined set.

The <frameworks> tag is an optional set of non-standard frameworks that the type or member is implemented on. The <compact> tag refers to the .NET Compact Framework and the <mono> tag refers to the MONO open source framework. Additional framework implementations can be specified within the <custom> tag within the <frameworks> tag.

The <platform> tag works in conjunction with the AdditionalFrameworkList, AdditionalOSList, DefaultOSSupport, InheritPlatformSupport, SupportCompactFrameworkByDefault and SupportMONOFrameworkByDefault documenter settings. These settings determine how items that do not have a platform specified in their code comments report platform compatibility.

#### Examples

    [C#]
    /// <platform>
    ///   <os predefined="all" />
    ///   <frameworks>
    ///     <mono>true</mono>
    ///     <compact>true</compact>
    ///   </frameworks>
    /// </platform>
    public class ThisClassSupportsAllPlatforms
    {
       /// <summary>
       /// This method should display the same list of platforms as the
       /// containing class ( if InheritPlatformSupport is true )
       /// </summary>
       public void ThisMethodShouldHaveTheSamePlatformAsTheClass()

       /// <platform>
       ///   <frameworks>
       ///     <compact>false</compact>
       ///   </frameworks>
       /// </platform>
       public void ThisMethodDoesNotSupportTheCF(){}
    }

#### See Also

Tag Usage | NDoc Tags, AdditionalFrameworkList, AdditionalOSList, DefaultOSSupport, InheritPlatformSupport, SupportCompactFrameworkByDefault, SupportMONOFrameworkByDefault