Author: jonpryor
Date: 2006-12-07 16:56:42 -0500 (Thu, 07 Dec 2006)
New Revision: 69209
Modified:
trunk/monodoc/tools/ChangeLog
trunk/monodoc/tools/DocTest-v1.cs
trunk/monodoc/tools/DocTest-v2.patch
trunk/monodoc/tools/DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml
trunk/monodoc/tools/DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml
trunk/monodoc/tools/DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml
trunk/monodoc/tools/DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml
trunk/monodoc/tools/DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html
trunk/monodoc/tools/monodocer.cs
trunk/monodoc/tools/stylesheet.xsl
Log:
* DocTest-v1.patch: Add an operator returning a generic parameter
(triggers
error fixed in monodocer.cs).
* DocTest-v2.patch: Update (due to changes in DocTest-v1.cs).
* monodocer.cs: CSharpFullMemberFormatter.AppendVisibility() needs to
accept null
MethodBases (when called from GetEventDeclaration() and
e.GetAddMethod()
returns null); fix SlashDocMemberFormatter.GetMethodDeclaration() so
that
generic types can be the return value of methods. These changes allow
generation of documentation on Mono's 2.0 mscorlib.dll.
* stylesheet.xsl: Use GetParameterType() to emit the return type of
explicit/implicit operators, as they can be/use generic arguments.
* DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml,
DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html:
Flush to match current output.
Modified: trunk/monodoc/tools/ChangeLog
===================================================================
--- trunk/monodoc/tools/ChangeLog 2006-12-07 21:17:14 UTC (rev 69208)
+++ trunk/monodoc/tools/ChangeLog 2006-12-07 21:56:42 UTC (rev 69209)
@@ -1,3 +1,22 @@
+2006-12-07 Jonathan Pryor <[EMAIL PROTECTED]>
+
+ * DocTest-v1.patch: Add an operator returning a generic parameter
(triggers
+ error fixed in monodocer.cs).
+ * DocTest-v2.patch: Update (due to changes in DocTest-v1.cs).
+ * monodocer.cs: CSharpFullMemberFormatter.AppendVisibility() needs to
accept null
+ MethodBases (when called from GetEventDeclaration() and
e.GetAddMethod()
+ returns null); fix SlashDocMemberFormatter.GetMethodDeclaration() so
that
+ generic types can be the return value of methods. These changes allow
+ generation of documentation on Mono's 2.0 mscorlib.dll.
+ * stylesheet.xsl: Use GetParameterType() to emit the return type of
+ explicit/implicit operators, as they can be/use generic arguments.
+ * DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
+
DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
+ DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml,
+ DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
+ DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html:
+ Flush to match current output.
+
2006-11-22 Jonathan Pryor <[EMAIL PROTECTED]>
* monodocer.cs: Don't generate documentation/prototypes for non-public
Modified:
trunk/monodoc/tools/DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml
===================================================================
---
trunk/monodoc/tools/DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml
2006-12-07 21:17:14 UTC (rev 69208)
+++
trunk/monodoc/tools/DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml
2006-12-07 21:56:42 UTC (rev 69209)
@@ -38,6 +38,22 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
+ <Member MemberName="op_Explicit">
+ <MemberSignature Language="C#" Value="public static U op_Explicit
(Mono.DocTest.Generic.GenericBase<U> list);" />
+ <MemberType>Method</MemberType>
+ <ReturnValue>
+ <ReturnType>U</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="list"
Type="Mono.DocTest.Generic.GenericBase<U>" />
+ </Parameters>
+ <Docs>
+ <param name="list">To be added.</param>
+ <summary>To be added.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
</Members>
<Docs>
<typeparam name="U">To be added.</typeparam>
Modified:
trunk/monodoc/tools/DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml
===================================================================
---
trunk/monodoc/tools/DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml
2006-12-07 21:17:14 UTC (rev 69208)
+++
trunk/monodoc/tools/DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml
2006-12-07 21:56:42 UTC (rev 69209)
@@ -16,6 +16,7 @@
<Docs>
<param name="i">To be added.</param>
<summary>To be added.</summary>
- <remarks>To be added.</remarks>
+ <remarks>
+ <c>T:Mono.DocTest.Widget.Del</c>.</remarks>
</Docs>
</Type>
Modified:
trunk/monodoc/tools/DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml
===================================================================
---
trunk/monodoc/tools/DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml
2006-12-07 21:17:14 UTC (rev 69208)
+++
trunk/monodoc/tools/DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml
2006-12-07 21:56:42 UTC (rev 69209)
@@ -38,6 +38,22 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
+ <Member MemberName="op_Explicit">
+ <MemberSignature Language="C#" Value="public static U op_Explicit
(Mono.DocTest.Generic.GenericBase<U> list);" />
+ <MemberType>Method</MemberType>
+ <ReturnValue>
+ <ReturnType>U</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="list"
Type="Mono.DocTest.Generic.GenericBase<U>" />
+ </Parameters>
+ <Docs>
+ <param name="list">To be added.</param>
+ <summary>To be added.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
</Members>
<Docs>
<typeparam name="U">Insert <c>text</c> here.</typeparam>
Modified:
trunk/monodoc/tools/DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml
===================================================================
---
trunk/monodoc/tools/DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml
2006-12-07 21:17:14 UTC (rev 69208)
+++
trunk/monodoc/tools/DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml
2006-12-07 21:56:42 UTC (rev 69209)
@@ -38,6 +38,22 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
+ <Member MemberName="op_Explicit">
+ <MemberSignature Language="C#" Value="public static U op_Explicit
(Mono.DocTest.Generic.GenericBase<U> list);" />
+ <MemberType>Method</MemberType>
+ <ReturnValue>
+ <ReturnType>U</ReturnType>
+ </ReturnValue>
+ <Parameters>
+ <Parameter Name="list"
Type="Mono.DocTest.Generic.GenericBase<U>" />
+ </Parameters>
+ <Docs>
+ <param name="list">To be added.</param>
+ <summary>To be added.</summary>
+ <returns>To be added.</returns>
+ <remarks>To be added.</remarks>
+ </Docs>
+ </Member>
<Member MemberName="AddedInVersion0_1_0_0">
<MemberSignature Language="C#" Value="public void AddedInVersion0_1_0_0
();" />
<MemberType>Method</MemberType>
Modified:
trunk/monodoc/tools/DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html
===================================================================
---
trunk/monodoc/tools/DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html
2006-12-07 21:17:14 UTC (rev 69208)
+++
trunk/monodoc/tools/DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html
2006-12-07 21:56:42 UTC (rev 69209)
@@ -100,6 +100,17 @@
</tr>
</table>
</div>
+ <h3>Operators</h3>
+ <div class="SubsectionBox">
+ <table class="MembersListing">
+ <tr valign="top">
+ <td>
+ <b>
+ <a
href="#M:Mono.DocTest.Generic.GenericBase`1.op_Explicit(Mono.DocTest.Generic.GenericBase{`0})~`0">Conversion
to U</a>
+ </b>(Explicit)<div>To be added.</div></td>
+ </tr>
+ </table>
+ </div>
</div>
</div>
<div class="Members">
@@ -143,6 +154,26 @@
<hr size="1">
</hr>
</div>
+ <h3
id="M:Mono.DocTest.Generic.GenericBase`1.op_Explicit(Mono.DocTest.Generic.GenericBase{`0})~`0"
class="MemberName">Conversion Method</h3>
+ <div class="MemberSignature">public static explicit operator <i
title="To be added.">U</i> (<a
href="../Mono.DocTest.Generic/GenericBase`1.html">GenericBase<U></a>
list)</div>
+ <div class="MemberBox">
+ <p>To be added.</p>
+ <h4 class="Subsection">Parameters</h4>
+ <div class="SubsectionBox">
+ <dl>
+ <dt>
+ <i>list</i>
+ </dt>
+ <dd>To be added.</dd>
+ </dl>
+ </div>
+ <h4 class="Subsection">Returns</h4>
+ <div class="SubsectionBox">To be added.</div>
+ <h4 class="Subsection">Remarks</h4>
+ <div class="SubsectionBox">To be added.</div>
+ <hr size="1">
+ </hr>
+ </div>
</div>
</div>
<hr size="1" />
Modified: trunk/monodoc/tools/DocTest-v1.cs
===================================================================
--- trunk/monodoc/tools/DocTest-v1.cs 2006-12-07 21:17:14 UTC (rev 69208)
+++ trunk/monodoc/tools/DocTest-v1.cs 2006-12-07 21:56:42 UTC (rev 69209)
@@ -233,6 +233,11 @@
public U BaseMethod<S> (S genericParameter) {
return default(U);
}
+
+ /// <param name="list">Insert description here</param>
+ ///
<remarks><c>M:Mono.DocTest.GenericBase`1.op_Explicit(Mono.DocTest.GenericBase{`0})~`0</c></remarks>
+ /// <returns>The default value for <typeparamref
name="U"/>.</returns>
+ public static explicit operator U (GenericBase<U> list) {return
default(U);}
}
/// <typeparam name="T">I'm Dying Here!</typeparam>
Modified: trunk/monodoc/tools/DocTest-v2.patch
===================================================================
--- trunk/monodoc/tools/DocTest-v2.patch 2006-12-07 21:17:14 UTC (rev
69208)
+++ trunk/monodoc/tools/DocTest-v2.patch 2006-12-07 21:56:42 UTC (rev
69209)
@@ -1,5 +1,5 @@
---- DocTest-v1.cs 2006-10-24 11:54:26.000000000 -0400
-+++ DocTest.cs 2006-10-24 11:57:38.000000000 -0400
+--- DocTest-v1.cs 2006-12-07 15:33:43.000000000 -0500
++++ DocTest.cs 2006-12-07 15:37:07.000000000 -0500
@@ -1,6 +1,9 @@
using System;
using System.Collections;
@@ -20,12 +20,12 @@
}
namespace Mono.DocTest.Generic {
-@@ -233,6 +239,8 @@
- public U BaseMethod<S> (S genericParameter) {
+@@ -234,6 +240,8 @@
return default(U);
}
+
++ public void AddedInVersion0_1_0_0 () {}
+
-+ public void AddedInVersion0_1_0_0 () {}
- }
-
- /// <typeparam name="T">I'm Dying Here!</typeparam>
+ /// <param name="list">Insert description here</param>
+ ///
<remarks><c>M:Mono.DocTest.GenericBase`1.op_Explicit(Mono.DocTest.GenericBase{`0})~`0</c></remarks>
+ /// <returns>The default value for <typeparamref
name="U"/>.</returns>
Modified: trunk/monodoc/tools/monodocer.cs
===================================================================
--- trunk/monodoc/tools/monodocer.cs 2006-12-07 21:17:14 UTC (rev 69208)
+++ trunk/monodoc/tools/monodocer.cs 2006-12-07 21:56:42 UTC (rev 69209)
@@ -1863,6 +1863,8 @@
protected override StringBuilder AppendVisibility (StringBuilder buf,
MethodBase method)
{
+ if (method == null)
+ return buf;
if (method.IsPublic)
return buf.Append ("public");
if (method.IsFamily)
@@ -2304,8 +2306,13 @@
string name = GetName (method);
if (name == null)
return null;
- if (method.Name == "op_Implicit" || method.Name ==
"op_Explicit")
+ if (method.Name == "op_Implicit" || method.Name ==
"op_Explicit") {
+ genDeclType = method.DeclaringType;
+ genDeclMethod = method;
name += "~" + GetName (method.ReturnType);
+ genDeclType = null;
+ genDeclMethod = null;
+ }
return "M:" + name;
}
Modified: trunk/monodoc/tools/stylesheet.xsl
===================================================================
--- trunk/monodoc/tools/stylesheet.xsl 2006-12-07 21:17:14 UTC (rev 69208)
+++ trunk/monodoc/tools/stylesheet.xsl 2006-12-07 21:56:42 UTC (rev 69209)
@@ -1772,7 +1772,13 @@
</xsl:if>
<xsl:if test="$member/@MemberName='op_Implicit' or
$member/@MemberName='op_Explicit'">
<xsl:text>~</xsl:text>
- <xsl:value-of select="$member/ReturnValue/ReturnType" />
+ <xsl:call-template name="GetParameterType">
+ <xsl:with-param name="type" select="$type" />
+ <xsl:with-param name="member" select="$member"
/>
+ <xsl:with-param name="parameter">
+ <Parameter
Type="{$member/ReturnValue/ReturnType}" />
+ </xsl:with-param>
+ </xsl:call-template>
</xsl:if>
</xsl:template>
_______________________________________________
Mono-patches maillist - [email protected]
http://lists.ximian.com/mailman/listinfo/mono-patches
