Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mono/api-doc-tools.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Pryor <jpryor@novell.com>2008-10-17 07:52:12 +0400
committerDuncan Mak <duncanm@microsoft.com>2016-10-08 03:28:26 +0300
commita88b1418d97118ff7239562ac47e9b75abdcb1ef (patch)
tree0c239c8ffcafc7bf64089ca4d309437e4fe534ce /mdoc/Test/en.expected.importecmadoc
parent9d519ffba860c1367ab58a1374ab3cdd63b2bbc5 (diff)
* . (svn:ignore), Test (svn:ignore): Ignore generated files.
* assembler.cs, mdoc.cs, monodocer.cs, monodocs2html.cs, monodocs2slashdoc.cs, normalize.cs, validate.cs, XhtmlWriter.cs: Move to Mono.Documentation. * defaulttemplate.xsl, overview.xsl, stylesheet.xsl: Moved to Resources. * DocTest: Moved to Test. * DocTest-v1.cs, DocTest-v2.patch, TestEcmaDocs.xml: Moved to Test. * mdoc.exe.sources: Added; mcs include file to build mdoc.exe. * Makefile: Added; build mdoc.exe, monodocer1.exe, and unit tests for mdoc.exe * Mono.Documentation/assembler.cs, Mono.Documentation/normalize.cs, Mono.Documentation/mdoc.cs, Mono.Documentation/monodocs2slashdoc.cs, Mono.Documentation/monodocs2html.cs, Mono.Documentation/validate.cs: Modify command line handling to remove Mono.GetOptions dependency. * Test/DocTest-v1.cs: Update //code/@src attribute due to changed paths. * Test/msxdoc-expected.importslashdoc.xml, * Test/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml: Flush due to above DocTest-v1.cs change. svn path=/trunk/mcs/; revision=116141
Diffstat (limited to 'mdoc/Test/en.expected.importecmadoc')
-rw-r--r--mdoc/Test/en.expected.importecmadoc/System/Action`1.xml31
-rw-r--r--mdoc/Test/en.expected.importecmadoc/System/Array.xml197
-rw-r--r--mdoc/Test/en.expected.importecmadoc/System/AsyncCallback.xml23
-rw-r--r--mdoc/Test/en.expected.importecmadoc/System/Environment.xml87
4 files changed, 338 insertions, 0 deletions
diff --git a/mdoc/Test/en.expected.importecmadoc/System/Action`1.xml b/mdoc/Test/en.expected.importecmadoc/System/Action`1.xml
new file mode 100644
index 00000000..fefaa9f9
--- /dev/null
+++ b/mdoc/Test/en.expected.importecmadoc/System/Action`1.xml
@@ -0,0 +1,31 @@
+<Type Name="Action&lt;T&gt;" FullName="System.Action&lt;T&gt;">
+ <TypeSignature Language="C#" Value="public delegate void Action&lt;T&gt;(T obj);" />
+ <AssemblyInfo>
+ <AssemblyName>DocTest</AssemblyName>
+ <AssemblyVersion>0.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <TypeParameters>
+ <TypeParameter Name="T" />
+ </TypeParameters>
+ <Base>
+ <BaseTypeName>System.Delegate</BaseTypeName>
+ </Base>
+ <Parameters>
+ <Parameter Name="obj" Type="T" />
+ </Parameters>
+ <ReturnValue>
+ <ReturnType>System.Void</ReturnType>
+ </ReturnValue>
+ <Docs>
+ <typeparam name="T">To be added.</typeparam>
+ <param name="obj">The object on which to perform an action.</param>
+ <summary>
+ <para> Represents the method that performs an action on the specified object.</para>
+ </summary>
+ <remarks>
+ <block subset="none" type="note">
+ <para>This delegate is used by the method <see cref="M:System.Array.ForEach" /><see langword="(T[], Action&lt;T&gt;)" />, and in <see cref="T:System.Collections.Generic.List&lt;T&gt;" /> to perform an action on each element of the collection.</para>
+ </block>
+ </remarks>
+ </Docs>
+</Type>
diff --git a/mdoc/Test/en.expected.importecmadoc/System/Array.xml b/mdoc/Test/en.expected.importecmadoc/System/Array.xml
new file mode 100644
index 00000000..c5df82e4
--- /dev/null
+++ b/mdoc/Test/en.expected.importecmadoc/System/Array.xml
@@ -0,0 +1,197 @@
+<Type Name="Array" FullName="System.Array">
+ <TypeSignature Language="C#" Value="public class Array" />
+ <AssemblyInfo>
+ <AssemblyName>DocTest</AssemblyName>
+ <AssemblyVersion>0.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Base>
+ <BaseTypeName>System.Object</BaseTypeName>
+ </Base>
+ <Interfaces />
+ <Docs>
+ <summary>
+ <para> Serves as the base class for arrays. Provides methods for creating,
+ copying, manipulating, searching, and sorting arrays.</para>
+ </summary>
+ <remarks>
+ <para>This class is intended to be used as a base class by
+ language implementations that support arrays. Only the system can derive from
+ this type: derived classes of <see cref="T:System.Array" /> are not to be created by the developer.</para>
+ <block subset="none" type="note">
+ <para>An array is a collection of
+ identically typed data <paramref name="elements" /> that are accessed and referenced by
+ sets of integral <paramref name="indices" />. </para>
+ <para>The <paramref name="rank" /> of an array is the number
+ of dimensions in the array. Each dimension has its own set of indices. An array
+ with a rank greater than one can have a different lower
+ bound and a different number of elements for each dimension. Multidimensional
+ arrays (i.e. arrays with a rank greater than one) are processed in row-major
+ order. </para>
+ <para>The <paramref name="lower bound" /> of a dimension
+ is the starting index of that dimension. </para>
+ <para>The <paramref name="length" /> of an array is the total number of elements contained in all of its
+dimensions. </para>
+ <para>A <paramref name="vector" /> is a
+one-dimensional array with a <paramref name="lower bound" /> of '0'. </para>
+ <para>If the implementer creates a derived class of <see cref="T:System.Array" />, expected <see cref="T:System.Array" /> behavior
+cannot be guaranteed. For information on array-like objects with increased
+functionality, see the <see cref="T:System.Collections.IList" /> and <see cref="T:System.Collections.Generic.IList&lt;T&gt;" /> interfaces. For more information regarding the use of arrays versus the use
+of collections, see Partition V of the CLI Specification. </para>
+ </block>
+ <para>Every specific <see cref="T:System.Array" /> type has three instance methods defined on it.
+ While some programming languages allow direct access to these methods, they are
+ primarily intended to be called by the output of compilers based on language
+ syntax that deals with arrays. </para>
+ <list type="bullet">
+ <item>
+ <term>
+ <para>
+ <c>Get</c>: Takes as many <see cref="T:System.Int32" /> arguments as the array
+ has dimensions and returns the value stored at the given index. It throws a
+<see cref="T:System.IndexOutOfRangeException" />
+exception for invalid indices. </para>
+ </term>
+ </item>
+ <item>
+ <term>
+ <para>
+ <c>Set</c>: Takes as many <see cref="T:System.Int32" /> arguments as the array
+ has dimensions, plus one additional argument (the last argument) which has the
+ same type as an array element. It stores the final value in the specified
+ index of the array. It throws a <see cref="T:System.IndexOutOfRangeException" />
+ exception for invalid indices. </para>
+ </term>
+ </item>
+ <item>
+ <term>
+ <para>
+ <c>Address</c>: Takes as many <see cref="T:System.Int32" /> arguments as the
+ array has dimensions and returns the address of the element at the given index.
+ It throws a <see cref="T:System.IndexOutOfRangeException" />
+ exception for invalid indices. </para>
+ </term>
+ </item>
+ </list>
+ <para>In addition, every specific <see cref="T:System.Array" /> type has a constructor on it that takes as many non-negative
+<see cref="T:System.Int32" />
+arguments as the array has dimensions. The arguments specify the
+number of elements in each dimension, and a lower bound of 0. Thus, a
+two-dimensional array of <see cref="T:System.Int32" /> objects would have a constructor that could be called with
+<c>(2, 4)</c> as its arguments to create an array of eight zeros with the first dimension indexed
+with 0 and 1 and the second dimension indexed with 0, 1, 2, and 3. </para>
+ <para>For all specific array types except vectors (i.e. those
+ permitted to have non-zero lower bounds and those with more than one dimension)
+ there is an additional constructor. It takes twice as many arguments as the
+ array has dimensions. The arguments are considered in pairs, with the first of
+ the pair specifying the lower bound for that dimension and the second specifying
+ the total number of elements in that dimension. Thus, a two-dimensional array
+ of <see cref="T:System.Int32" />
+
+ objects would also have a constructor that could be called with <c>(-1, 2, 1, 3)</c> as its arguments,
+specifying an array of 6 zeros, with the first dimension indexed by -1 and 0,
+and the second dimension indexed by 1, 2, and 3. </para>
+ <para>Enumeration over an array occurs in ascending row-major order, starting from the first element. (For example, a 2x3 array is traversed in the order [0,0], [0,1], [0,2], [1,0], [1,1], and [1,2].)</para>
+ <para>Parallel implementation of methods taking a <see cref="T:System.Predicate" /> argument are not permitted.</para>
+ </remarks>
+ </Docs>
+ <Members>
+ <Member MemberName=".ctor">
+ <MemberSignature Language="C#" Value="public Array ();" />
+ <MemberSignature Language="ILAsm" Value="private rtspecialname specialname instance void .ctor()" />
+ <MemberType>Constructor</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>0.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Parameters />
+ <Docs>
+ <summary>Constructs a new instance of the <see cref="T:System.Array" /> class.</summary>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="AsReadOnly&lt;T&gt;">
+ <MemberSignature Language="C#" Value="public static System.Collections.ObjectModel.ReadOnlyCollection&lt;T&gt; AsReadOnly&lt;T&gt; (T[] array);" />
+ <MemberType>Method</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>0.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.Collections.ObjectModel.ReadOnlyCollection&lt;T&gt;</ReturnType>
+ </ReturnValue>
+ <TypeParameters>
+ <TypeParameter Name="T" />
+ </TypeParameters>
+ <Parameters>
+ <Parameter Name="array" Type="T[]" />
+ </Parameters>
+ <Docs>
+ <typeparam name="T">To be added.</typeparam>
+ <param name="array">To be added.</param>
+ <summary>To be added.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ <Member MemberName="ConvertAll&lt;T,U&gt;">
+ <MemberSignature Language="C#" Value="public static TOutput[] ConvertAll&lt;TInput,TOutput&gt; (TInput[] array, Converter&lt;TInput,TOutput&gt; converter);" />
+ <MemberSignature Language="ILAsm" Value=".method public hidebysig static !!1[] ConvertAll&lt;T,U&gt;(!!0[] array, class System.Converter`1&lt;!!0,!!1&gt; converter)" />
+ <MemberType>Method</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>0.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>TOutput[]</ReturnType>
+ </ReturnValue>
+ <TypeParameters>
+ <TypeParameter Name="TInput" />
+ <TypeParameter Name="TOutput" />
+ </TypeParameters>
+ <Parameters>
+ <Parameter Name="array" Type="TInput[]" />
+ <Parameter Name="converter" Type="System.Converter&lt;TInput,TOutput&gt;" />
+ </Parameters>
+ <Docs>
+ <typeparam name="TInput">To be added.</typeparam>
+ <typeparam name="TOutput">To be added.</typeparam>
+ <param name="array">The one-dimensional array to convert.</param>
+ <param name="converter">
+ <para>A <see cref="T:System.Converter&lt;T,U&gt;" /> that converts each element from one type to another type.</para>
+ </param>
+ <summary>
+ <para>Converts an array of one type to an array of another type.</para>
+ </summary>
+ <returns>
+ <para>A new array of the target type containing the converted elements from <paramref name="array" />.</para>
+ </returns>
+ <remarks>
+ <para>The <see cref="T:System.Converter&lt;T,U&gt;" /> is a delegate that converts an array element to the target type. The elements of <paramref name="array" /> are individually passed to this converter, and the converted elements are saved in the new array. The source array remains unchanged.</para>
+ </remarks>
+ <exception cref="T:System.ArgumentNullException">
+ <paramref name="array" /> is <see langword="null" /> or <paramref name="converter" /> is <see langword="null" />.</exception>
+ </Docs>
+ </Member>
+ <Member MemberName="Resize&lt;T&gt;">
+ <MemberSignature Language="C#" Value="public static void Resize&lt;T&gt; (ref T[] array, int newSize);" />
+ <MemberType>Method</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>0.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.Void</ReturnType>
+ </ReturnValue>
+ <TypeParameters>
+ <TypeParameter Name="T" />
+ </TypeParameters>
+ <Parameters>
+ <Parameter Name="array" Type="T[]&amp;" RefType="ref" />
+ <Parameter Name="newSize" Type="System.Int32" />
+ </Parameters>
+ <Docs>
+ <typeparam name="T">To be added.</typeparam>
+ <param name="array">To be added.</param>
+ <param name="newSize">To be added.</param>
+ <summary>To be added.</summary>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
+ </Members>
+</Type>
diff --git a/mdoc/Test/en.expected.importecmadoc/System/AsyncCallback.xml b/mdoc/Test/en.expected.importecmadoc/System/AsyncCallback.xml
new file mode 100644
index 00000000..2049b23d
--- /dev/null
+++ b/mdoc/Test/en.expected.importecmadoc/System/AsyncCallback.xml
@@ -0,0 +1,23 @@
+<Type Name="AsyncCallback" FullName="System.AsyncCallback">
+ <TypeSignature Language="C#" Value="public delegate void AsyncCallback(IAsyncResult ar);" />
+ <AssemblyInfo>
+ <AssemblyName>DocTest</AssemblyName>
+ <AssemblyVersion>0.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Base>
+ <BaseTypeName>System.Delegate</BaseTypeName>
+ </Base>
+ <Parameters>
+ <Parameter Name="ar" Type="System.IAsyncResult" />
+ </Parameters>
+ <ReturnValue>
+ <ReturnType>System.Void</ReturnType>
+ </ReturnValue>
+ <Docs>
+ <param name="ar">A <see cref="T:System.IAsyncResult" /> object containing information about the asynchronous operation that has completed.</param>
+ <summary>
+ <para> References one or more methods called when an asynchronous operation completes.</para>
+ </summary>
+ <remarks>To be added.</remarks>
+ </Docs>
+</Type>
diff --git a/mdoc/Test/en.expected.importecmadoc/System/Environment.xml b/mdoc/Test/en.expected.importecmadoc/System/Environment.xml
new file mode 100644
index 00000000..73f22046
--- /dev/null
+++ b/mdoc/Test/en.expected.importecmadoc/System/Environment.xml
@@ -0,0 +1,87 @@
+<Type Name="Environment" FullName="System.Environment">
+ <TypeSignature Language="C#" Value="public static class Environment" />
+ <AssemblyInfo>
+ <AssemblyName>DocTest</AssemblyName>
+ <AssemblyVersion>0.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <Base>
+ <BaseTypeName>System.Object</BaseTypeName>
+ </Base>
+ <Interfaces />
+ <Docs>
+ <summary>
+ <para> Provides the current settings for, and information about, the execution environment.</para>
+ </summary>
+ <remarks>
+ <block subset="none" type="note">
+ <para>Use this class to retrieve the following
+ information:</para>
+ <list type="bullet">
+ <item>
+ <term>Command line arguments</term>
+ </item>
+ <item>
+ <term>Exit codes</term>
+ </item>
+ <item>
+ <term>Environment variable settings</term>
+ </item>
+ <item>
+ <term>Contents of the call stack</term>
+ </item>
+ <item>
+ <term>Time since last system boot</term>
+ </item>
+ <item>
+ <term>Version of the execution engine</term>
+ </item>
+ </list>
+ </block>
+ </remarks>
+ </Docs>
+ <Members>
+ <Member MemberName="GetFolderPath">
+ <MemberSignature Language="C#" Value="public static string GetFolderPath (Environment.SpecialFolder folder);" />
+ <MemberType>Method</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>0.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.String</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="folder" Type="System.Environment+SpecialFolder" />
+ </Parameters>
+ <Docs>
+ <param name="folder">
+ <para>A <see cref="T:System.Environment+SpecialFolder" />.</para>
+ </param>
+ <summary>
+ <para> Returns the arguments specified on the command
+ line.</para>
+ </summary>
+ <returns>
+ <para> Returns a <see cref="T:System.String" /> array. Each <see cref="T:System.String" /> in the array
+ contains a single command line argument.</para>
+ </returns>
+ <remarks>
+ <para>The first element in the array contains the filename of
+ the executing program. If the filename is not available, the first element is
+ equal to <see cref="F:System.String.Empty" />. The remaining elements contain any additional tokens
+ entered on the command line.</para>
+ <block subset="none" type="note">
+ <para>The program filename can, but is not required to,
+ include path information.</para>
+ <para>To obtain the command line as a single <see cref="T:System.String" />, use the <see cref="P:System.Environment.CommandLine" />
+ property.</para>
+ </block>
+ </remarks>
+ <exception cref="T:System.ArgumentException">foo</exception>
+ <permission cref="T:System.SomePermission">bar</permission>
+ <altmember cref="T:System.SomeMember">alt member</altmember>
+ <seealso cref="T:System.SomeMember">another member</seealso>
+ <unrecognized attribute="a-ko">should be appended to new docs</unrecognized>
+ </Docs>
+ </Member>
+ </Members>
+</Type>