mcs/tools/mdoc/Test/en.expected.importecmadoc/System/Environment.xml

   1 <Type Name="Environment" FullName="System.Environment">
   2   <TypeSignature Language="C#" Value="public static class Environment" />
   3   <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit Environment extends System.Object" />
   4   <AssemblyInfo>
   5     <AssemblyName>DocTest</AssemblyName>
   6     <AssemblyVersion>0.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Object</BaseTypeName>
  10   </Base>
  11   <Interfaces />
  12   <Docs>
  13     <summary>
  14       <para> Provides the current settings for, and information about, the execution environment.</para>
  15     </summary>
  16     <remarks>
  17       <block subset="none" type="note">
  18         <para>Use this class to retrieve the following
  19  information:</para>
  20         <list type="bullet">
  21           <item>
  22             <term>Command line arguments</term>
  23           </item>
  24           <item>
  25             <term>Exit codes</term>
  26           </item>
  27           <item>
  28             <term>Environment variable settings</term>
  29           </item>
  30           <item>
  31             <term>Contents of the call stack</term>
  32           </item>
  33           <item>
  34             <term>Time since last system boot</term>
  35           </item>
  36           <item>
  37             <term>Version of the execution engine</term>
  38           </item>
  39         </list>
  40       </block>
  41     </remarks>
  42   </Docs>
  43   <Members>
  44     <Member MemberName="GetFolderPath">
  45       <MemberSignature Language="C#" Value="public static string GetFolderPath (Environment.SpecialFolder folder);" />
  46       <MemberSignature Language="ILAsm" Value=".method public static hidebysig string GetFolderPath(valuetype System.Environment/SpecialFolder folder) cil managed" />
  47       <MemberType>Method</MemberType>
  48       <AssemblyInfo>
  49         <AssemblyVersion>0.0.0.0</AssemblyVersion>
  50       </AssemblyInfo>
  51       <ReturnValue>
  52         <ReturnType>System.String</ReturnType>
  53       </ReturnValue>
  54       <Parameters>
  55         <Parameter Name="folder" Type="System.Environment+SpecialFolder" />
  56       </Parameters>
  57       <Docs>
  58         <param name="folder">
  59           <para>A <see cref="T:System.Environment+SpecialFolder" />.</para>
  60         </param>
  61         <summary>
  62           <para> Returns the arguments specified on the command
  63       line.</para>
  64         </summary>
  65         <returns>
  66           <para> Returns a <see cref="T:System.String" /> array. Each <see cref="T:System.String" /> in the array
  67    contains a single command line argument.</para>
  68         </returns>
  69         <remarks>
  70           <para>The first element in the array contains the filename of
  71       the executing program. If the filename is not available, the first element is
  72       equal to <see cref="F:System.String.Empty" />. The remaining elements contain any additional tokens
  73       entered on the command line.</para>
  74           <block subset="none" type="note">
  75             <para>The program filename can, but is not required to,
  76          include path information.</para>
  77             <para>To obtain the command line as a single <see cref="T:System.String" />, use the <see cref="P:System.Environment.CommandLine" />
  78    property.</para>
  79           </block>
  80         </remarks>
  81         <exception cref="T:System.NotSupportedException">To be added; from:
  82           <see cref="M:System.Environment.GetFolderPath(System.Environment.SpecialFolder)" /></exception>
  83         <exception cref="T:System.ArgumentException">foo</exception>
  84         <permission cref="T:System.SomePermission">bar</permission>
  85         <altmember cref="T:System.SomeMember">alt member</altmember>
  86         <seealso cref="T:System.SomeMember">another member</seealso>
  87         <unrecognized attribute="a-ko">should be appended to new docs</unrecognized>
  88       </Docs>
  89     </Member>
  90   </Members>
  91 </Type>