diff options
| author | Jonathan Pryor <jpryor@novell.com> | 2008-11-15 00:24:54 +0300 |
|---|---|---|
| committer | Duncan Mak <duncanm@microsoft.com> | 2016-10-08 03:28:32 +0300 |
| commit | 6770b6c7aaa799b2864b68f7ac125a84044db7b9 (patch) | |
| tree | 14297b6d89e22e7e21e2954d3903775610c9e0c3 /mdoc/Test/en.expected.since | |
| parent | 67b0db87ca24a3fef144b57470abcb325094b793 (diff) | |
* Makefile: Don't build monodocer1.exe, and add Mono.Cecil.dll to the
list of assembly references for mdoc.exe.
* Mono.Documentation/monodocer.cs: Migrate from System.Reflection to
Mono.Cecil. This was done for two reasons:
1. mscorlib.dll: Reflection can load only one mscorlib.dll into an
AppDomain, which must be the same mscorlib.dll as the runtime
version. Thus, in order to run monodocer on mscorlib.dll v1.1,
monodocer must be a .NET 1.1 application, and to document
mscorlib.dll v2.0, monodocer must be a .net 2.0 app.
1.a I don't think it's feasable to drop support for
mscorlib.dll v1.1.
1.b This has been previously handled (so far) with conditional
compilation, but the conditional compilation is painful to
maintain, and prevents use of LINQ in ongoing development.
1.c .NET 4.0 will be coming out "soon" (within 2 years?), and it's
possible that mono will maintain the same limitation, thus
necessitating having *three* different monodocer programs to
document mscorlib.dll for v1.1, v2.0, and v4.0. Yech.
2. Future directions: It would be nice to parse method/property IL
bodies to determine which exceptions can be generated, thus
generating <exception cref="..."/> stubs. Even with empty stubs,
I belive this would be useful within e.g. MonoDevelop to know
which exceptions a method is able to generate.
This cannot be done (at present) with System.Reflection, and
would require Mono.Cecil.
Downsides: mdoc now depends upon Mono.Cecil, which is API-unstable.
This will likely also complicate execution under .NET, as Mono.Cecil
would need to be XCOPY deployed into mdoc.exe's directory.
* Test/DocTest-v1.cs: Add additional tests for Custom Attribute
generation.
* Test/en.expected.importslashdoc/Mono.DocTest.Generic/Func`2.xml,
Test/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
Test/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
Test/en.expected.importslashdoc/Mono.DocTest/Widget+Direction.xml,
Test/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
Test/en.expected.since/Mono.DocTest.Generic/Func`2.xml,
Test/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
Test/en.expected.since/Mono.DocTest/DocAttribute.xml,
Test/en.expected.since/Mono.DocTest/Widget+Direction.xml,
Test/en.expected.since/Mono.DocTest/Widget.xml,
Test/en.expected/Mono.DocTest.Generic/Func`2.xml,
Test/en.expected/Mono.DocTest.Generic/MyList`2.xml,
Test/en.expected/Mono.DocTest/DocAttribute.xml,
Test/en.expected/Mono.DocTest/Widget+Direction.xml,
Test/en.expected/Mono.DocTest/Widget.xml,
Test/html.expected/Mono.DocTest.Generic/Func`2.html,
Test/html.expected/Mono.DocTest.Generic/MyList`2.html,
Test/html.expected/Mono.DocTest/DocAttribute.html,
Test/html.expected/Mono.DocTest/Widget+Direction.html,
Test/html.expected/Mono.DocTest/Widget.html,
Test/msxdoc-expected.importslashdoc.xml: Flush -- updated output due
to new custom attributes, better implemented interface detection --
care of the Mono.Cecil migration -- etc.
svn path=/trunk/mcs/; revision=118892
Diffstat (limited to 'mdoc/Test/en.expected.since')
5 files changed, 75 insertions, 6 deletions
diff --git a/mdoc/Test/en.expected.since/Mono.DocTest.Generic/Func`2.xml b/mdoc/Test/en.expected.since/Mono.DocTest.Generic/Func`2.xml index 42eeaa5d..cfa836a0 100644 --- a/mdoc/Test/en.expected.since/Mono.DocTest.Generic/Func`2.xml +++ b/mdoc/Test/en.expected.since/Mono.DocTest.Generic/Func`2.xml @@ -45,7 +45,7 @@ <ReturnType>TRet</ReturnType> <Attributes> <Attribute> - <AttributeName>Mono.DocTest.Doc("return")</AttributeName> + <AttributeName>Mono.DocTest.Doc("return", Field=false)</AttributeName> </Attribute> </Attributes> </ReturnValue> diff --git a/mdoc/Test/en.expected.since/Mono.DocTest.Generic/MyList`2.xml b/mdoc/Test/en.expected.since/Mono.DocTest.Generic/MyList`2.xml index 90b2dbc2..b8f98939 100644 --- a/mdoc/Test/en.expected.since/Mono.DocTest.Generic/MyList`2.xml +++ b/mdoc/Test/en.expected.since/Mono.DocTest.Generic/MyList`2.xml @@ -1,5 +1,5 @@ <Type Name="MyList<A,B>" FullName="Mono.DocTest.Generic.MyList<A,B>"> - <TypeSignature Language="C#" Value="public class MyList<A,B> : Mono.DocTest.Generic.GenericBase<System.Collections.Generic.Dictionary<A,B>>, Mono.DocTest.Generic.IFoo<A>, System.Collections.Generic.ICollection<A>, System.Collections.Generic.IEnumerator<A> where A : class, IList<B>, new() where B : class, A" /> + <TypeSignature Language="C#" Value="public class MyList<A,B> : Mono.DocTest.Generic.GenericBase<System.Collections.Generic.Dictionary<A,B>>, Mono.DocTest.Generic.IFoo<A>, System.Collections.Generic.ICollection<A>, System.Collections.Generic.IEnumerable<A>, System.Collections.Generic.IEnumerator<A> where A : class, IList<B>, new() where B : class, A" /> <AssemblyInfo> <AssemblyName>DocTest</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -34,6 +34,9 @@ <InterfaceName>System.Collections.Generic.ICollection<A></InterfaceName> </Interface> <Interface> + <InterfaceName>System.Collections.Generic.IEnumerable<A></InterfaceName> + </Interface> + <Interface> <InterfaceName>System.Collections.Generic.IEnumerator<A></InterfaceName> </Interface> </Interfaces> diff --git a/mdoc/Test/en.expected.since/Mono.DocTest/DocAttribute.xml b/mdoc/Test/en.expected.since/Mono.DocTest/DocAttribute.xml index 5a4ee45b..7fcb233b 100644 --- a/mdoc/Test/en.expected.since/Mono.DocTest/DocAttribute.xml +++ b/mdoc/Test/en.expected.since/Mono.DocTest/DocAttribute.xml @@ -35,5 +35,66 @@ <remarks>To be added.</remarks> </Docs> </Member> + <Member MemberName="Field"> + <MemberSignature Language="C#" Value="public bool Field;" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Boolean</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="FlagsEnum"> + <MemberSignature Language="C#" Value="public ConsoleModifiers FlagsEnum;" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.ConsoleModifiers</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="NonFlagsEnum"> + <MemberSignature Language="C#" Value="public Mono.DocTest.Color NonFlagsEnum;" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Mono.DocTest.Color</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Property"> + <MemberSignature Language="C#" Value="public Type Property { set; get; }" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Type</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> </Members> </Type> diff --git a/mdoc/Test/en.expected.since/Mono.DocTest/Widget+Direction.xml b/mdoc/Test/en.expected.since/Mono.DocTest/Widget+Direction.xml index 285e8637..1b02291b 100644 --- a/mdoc/Test/en.expected.since/Mono.DocTest/Widget+Direction.xml +++ b/mdoc/Test/en.expected.since/Mono.DocTest/Widget+Direction.xml @@ -8,6 +8,11 @@ <Base> <BaseTypeName>System.Enum</BaseTypeName> </Base> + <Attributes> + <Attribute> + <AttributeName>System.Flags</AttributeName> + </Attribute> + </Attributes> <Docs> <summary>To be added.</summary> <remarks>To be added.</remarks> diff --git a/mdoc/Test/en.expected.since/Mono.DocTest/Widget.xml b/mdoc/Test/en.expected.since/Mono.DocTest/Widget.xml index 21786a36..16f00069 100644 --- a/mdoc/Test/en.expected.since/Mono.DocTest/Widget.xml +++ b/mdoc/Test/en.expected.since/Mono.DocTest/Widget.xml @@ -236,14 +236,14 @@ </AssemblyInfo> <Attributes> <Attribute> - <AttributeName>Mono.DocTest.Doc("normal DocAttribute")</AttributeName> + <AttributeName>Mono.DocTest.Doc("normal DocAttribute", Field=true)</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Void</ReturnType> <Attributes> <Attribute> - <AttributeName>Mono.DocTest.Doc("return:DocAttribute")</AttributeName> + <AttributeName>Mono.DocTest.Doc("return:DocAttribute", Property=typeof(Mono.DocTest.Widget))</AttributeName> </Attribute> </Attributes> </ReturnValue> @@ -251,14 +251,14 @@ <Parameter Name="c" Type="System.Char"> <Attributes> <Attribute> - <AttributeName>Mono.DocTest.Doc("c")</AttributeName> + <AttributeName>Mono.DocTest.Doc("c", FlagsEnum=System.ConsoleModifiers.Alt | System.ConsoleModifiers.Control)</AttributeName> </Attribute> </Attributes> </Parameter> <Parameter Name="f" Type="System.Single&" RefType="out"> <Attributes> <Attribute> - <AttributeName>Mono.DocTest.Doc("f")</AttributeName> + <AttributeName>Mono.DocTest.Doc("f", NonFlagsEnum=Mono.DocTest.Color.Red)</AttributeName> </Attribute> </Attributes> </Parameter> |