2005-06-22 Mike Kestner <mkestner@novell.com>

* gen-vm-docs.cs : some monodocer formatting changes and attr lookup
	enhancements.

svn path=/trunk/gtk-sharp/; revision=46377
This commit is contained in:
Mike Kestner 2005-06-22 18:04:17 +00:00
parent d3c6721f1e
commit 828f30b5a5
6 changed files with 53 additions and 53 deletions

View file

@ -1,3 +1,8 @@
2005-06-22 Mike Kestner <mkestner@novell.com>
* gen-vm-docs.cs : some monodocer formatting changes and attr lookup
enhancements.
2005-06-16 Mike Kestner <mkestner@novell.com> 2005-06-16 Mike Kestner <mkestner@novell.com>
* en/*/*.xml : run the versionator to add since elements for 2.6. * en/*/*.xml : run the versionator to add since elements for 2.6.

View file

@ -701,7 +701,6 @@ All UI components in an application which provide useful information or services
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Atk.Object.StateChange" /> event.</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Atk.Object.StateChange" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Object (GLib.GType gtype);" /> <MemberSignature Language="C#" Value="protected Object (GLib.GType gtype);" />
<MemberType>Constructor</MemberType> <MemberType>Constructor</MemberType>
@ -785,7 +784,7 @@ All UI components in an application which provide useful information or services
</Attribute> </Attribute>
</Attributes> </Attributes>
</Member> </Member>
<Member MemberName="OnPropertyChange"> <Member MemberName="OnPropertyChange">
<MemberSignature Language="C#" Value="protected virtual void OnPropertyChange (Atk.PropertyValues values);" /> <MemberSignature Language="C#" Value="protected virtual void OnPropertyChange (Atk.PropertyValues values);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
<ReturnValue> <ReturnValue>
@ -796,9 +795,9 @@ All UI components in an application which provide useful information or services
</Parameters> </Parameters>
<Docs> <Docs>
<param name="values">To be added.</param> <param name="values">To be added.</param>
<summary>To be added.</summary> <summary>Default handler for the <see cref="M:Atk.Object.PropertyChange" /> event.</summary>
<remarks>To be added.</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Atk.Object.PropertyChange" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View file

@ -390,7 +390,6 @@
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RequestRedraw"> <Member MemberName="RequestRedraw">
<MemberSignature Language="C#" Value="public void RequestRedraw (int x1, int y1, int x2, int y2);" /> <MemberSignature Language="C#" Value="public void RequestRedraw (int x1, int y1, int x2, int y2);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
@ -641,7 +640,6 @@
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Canvas (IntPtr raw);" /> <MemberSignature Language="C#" Value="public Canvas (IntPtr raw);" />
<MemberType>Constructor</MemberType> <MemberType>Constructor</MemberType>
@ -754,11 +752,12 @@
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
<Attributes> <Attributes>
<Attribute> <Attribute>
<AttributeName>GLib.Property(Name="aa")</AttributeName> <AttributeName>GLib.Property(Name="aa")</AttributeName>
</Attribute> </Attribute>
</Attributes></Member> </Attributes>
</Member>
<Member MemberName="DrawBackground"> <Member MemberName="DrawBackground">
<MemberSignature Language="C#" Value="public event Gnome.DrawBackgroundHandler DrawBackground;" /> <MemberSignature Language="C#" Value="public event Gnome.DrawBackgroundHandler DrawBackground;" />
<MemberType>Event</MemberType> <MemberType>Event</MemberType>
@ -775,11 +774,12 @@
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
<Attributes> <Attributes>
<Attribute> <Attribute>
<AttributeName>GLib.Signal(CName="draw_background")</AttributeName> <AttributeName>GLib.Signal(CName="draw_background")</AttributeName>
</Attribute> </Attribute>
</Attributes></Member> </Attributes>
</Member>
<Member MemberName="RenderBackground"> <Member MemberName="RenderBackground">
<MemberSignature Language="C#" Value="public event Gnome.RenderBackgroundHandler RenderBackground;" /> <MemberSignature Language="C#" Value="public event Gnome.RenderBackgroundHandler RenderBackground;" />
<MemberType>Event</MemberType> <MemberType>Event</MemberType>
@ -797,11 +797,12 @@
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
<Attributes> <Attributes>
<Attribute> <Attribute>
<AttributeName>GLib.Signal(CName="render_background")</AttributeName> <AttributeName>GLib.Signal(CName="render_background")</AttributeName>
</Attribute> </Attribute>
</Attributes></Member> </Attributes>
</Member>
<Member MemberName="GetScrollRegion"> <Member MemberName="GetScrollRegion">
<MemberSignature Language="C#" Value="public void GetScrollRegion (out double x1, out double y1, out double x2, out double y2);" /> <MemberSignature Language="C#" Value="public void GetScrollRegion (out double x1, out double y1, out double x2, out double y2);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
@ -859,7 +860,6 @@
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gnome.Canvas" />.</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gnome.Canvas" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnDrawBackground"> <Member MemberName="OnDrawBackground">
<MemberSignature Language="C#" Value="protected virtual void OnDrawBackground (Gdk.Drawable drawable, int x, int y, int width, int height);" /> <MemberSignature Language="C#" Value="protected virtual void OnDrawBackground (Gdk.Drawable drawable, int x, int y, int width, int height);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
@ -895,11 +895,12 @@
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks> <remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs> </Docs>
<Attributes> <Attributes>
<Attribute> <Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName> <AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute> </Attribute>
</Attributes></Member> </Attributes>
</Member>
<Member MemberName="PixelsPerUnit"> <Member MemberName="PixelsPerUnit">
<MemberSignature Language="C#" Value="public double PixelsPerUnit { set; get; };" /> <MemberSignature Language="C#" Value="public double PixelsPerUnit { set; get; };" />
<MemberType>Property</MemberType> <MemberType>Property</MemberType>
@ -925,7 +926,7 @@
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="W2cAffine"> <Member MemberName="W2cAffine">
<MemberSignature Language="C#" Value="public void W2cAffine (out double[] affine);" /> <MemberSignature Language="C#" Value="public void W2cAffine (out double[] affine);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
<ReturnValue> <ReturnValue>
@ -940,7 +941,7 @@
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnRenderBackground"> <Member MemberName="OnRenderBackground">
<MemberSignature Language="C#" Value="protected virtual void OnRenderBackground (Gnome.CanvasBuf buf);" /> <MemberSignature Language="C#" Value="protected virtual void OnRenderBackground (Gnome.CanvasBuf buf);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
<ReturnValue> <ReturnValue>
@ -951,9 +952,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<param name="buf">To be added.</param> <param name="buf">To be added.</param>
<summary>To be added.</summary> <summary>Default handler for the <see cref="M:Gnome.Canvas.RenderBackground" /> event.</summary>
<remarks>To be added.</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.Canvas.RenderBackground" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View file

@ -386,7 +386,6 @@
</Attribute> </Attribute>
</Attributes> </Attributes>
</Member> </Member>
<Member MemberName="WaitForImage"> <Member MemberName="WaitForImage">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf WaitForImage ();" /> <MemberSignature Language="C#" Value="public Gdk.Pixbuf WaitForImage ();" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
@ -479,7 +478,7 @@
<since version="Gtk# 2.6" /> <since version="Gtk# 2.6" />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnOwnerChange"> <Member MemberName="OnOwnerChange">
<MemberSignature Language="C#" Value="protected virtual void OnOwnerChange (Gdk.EventOwnerChange evnt);" /> <MemberSignature Language="C#" Value="protected virtual void OnOwnerChange (Gdk.EventOwnerChange evnt);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
<ReturnValue> <ReturnValue>
@ -489,9 +488,10 @@
<Parameter Name="evnt" Type="Gdk.EventOwnerChange" /> <Parameter Name="evnt" Type="Gdk.EventOwnerChange" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="evnt">To be added.</param> <param name="evnt">An event describing the owner change.</param>
<summary>To be added.</summary> <summary>Default handler for the <see cref="M:Gtk.Clipboard.OwnerChange" /> event.</summary>
<remarks>To be added.</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Clipboard.OwnerChange" /> event.</remarks>
<since version="Gtk# 2.6" />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -461,8 +461,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Default handler for the <see cref="M:Gtk.FileChooserButton.SelectionChanged" /> event.</summary>
<remarks>To be added.</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.FileChooserButton.SelectionChanged" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnFileActivated"> <Member MemberName="OnFileActivated">
@ -473,8 +473,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Default handler for the <see cref="M:Gtk.FileChooserButton.FileActivated" /> event.</summary>
<remarks>To be added.</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.FileChooserButton.FileActivated" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnUpdatePreview"> <Member MemberName="OnUpdatePreview">
@ -485,8 +485,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Default handler for the <see cref="M:Gtk.FileChooserButton.UpdatePreview" /> event.</summary>
<remarks>To be added.</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.FileChooserButton.UpdatePreview" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnCurrentFolderChanged"> <Member MemberName="OnCurrentFolderChanged">
@ -497,8 +497,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Default handler for the <see cref="M:Gtk.FileChooserButton.CurrentFolderChanged" /> event.</summary>
<remarks>To be added.</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.FileChooserButton.CurrentFolderChanged" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CurrentFolderUri"> <Member MemberName="CurrentFolderUri">
@ -694,4 +694,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View file

@ -31,7 +31,6 @@ namespace GtkSharp.Docs {
public static int Main (string[] args) public static int Main (string[] args)
{ {
string api_filename = "";
XmlDocument api_doc = new XmlDocument (); XmlDocument api_doc = new XmlDocument ();
BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly; BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly;
@ -51,27 +50,20 @@ namespace GtkSharp.Docs {
Hashtable sigs = new Hashtable (); Hashtable sigs = new Hashtable ();
foreach (EventInfo ei in t.GetEvents (flags)) { foreach (EventInfo ei in t.GetEvents (flags))
foreach (Attribute attr in ei.GetCustomAttributes (false)) { foreach (GLib.SignalAttribute attr in ei.GetCustomAttributes (typeof (GLib.SignalAttribute), false))
if (attr.ToString () == "GLib.SignalAttribute") { sigs [attr.CName] = ei.Name;
sigs [((GLib.SignalAttribute) attr).CName] = ei.Name;
break;
}
}
}
if (sigs.Count == 0) continue; if (sigs.Count == 0) continue;
Hashtable vms = new Hashtable (); Hashtable vms = new Hashtable ();
foreach (MethodInfo mi in t.GetMethods (flags)) { foreach (MethodInfo mi in t.GetMethods (flags)) {
foreach (Attribute attr in mi.GetCustomAttributes (false)) { foreach (GLib.DefaultSignalHandlerAttribute attr in mi.GetCustomAttributes (typeof (GLib.DefaultSignalHandlerAttribute), false)) {
if (attr.ToString () == "GLib.DefaultSignalHandlerAttribute") { string conn_name = attr.ConnectionMethod;
string conn_name = ((GLib.DefaultSignalHandlerAttribute) attr).ConnectionMethod; if (sigs.ContainsValue (conn_name.Substring (8)))
if (sigs.ContainsValue (conn_name.Substring (8))) vms [mi.Name] = conn_name.Substring (8);
vms [mi.Name] = conn_name.Substring (8);
break;
}
} }
} }
@ -91,6 +83,7 @@ namespace GtkSharp.Docs {
XPathNavigator api_nav = api_doc.CreateNavigator (); XPathNavigator api_nav = api_doc.CreateNavigator ();
bool dirty = false;
foreach (string vm in vms.Keys) { foreach (string vm in vms.Keys) {
XPathNodeIterator iter = api_nav.Select ("/Type/Members/Member[@MemberName='" + vm + "']"); XPathNodeIterator iter = api_nav.Select ("/Type/Members/Member[@MemberName='" + vm + "']");
@ -100,16 +93,18 @@ namespace GtkSharp.Docs {
XmlElement rem = elem ["Docs"] ["remarks"]; XmlElement rem = elem ["Docs"] ["remarks"];
string summary = summ.InnerXml; string summary = summ.InnerXml;
string remarks = rem.InnerXml; string remarks = rem.InnerXml;
if (summary == "To be added" && remarks == "To be added") { if (summary == "To be added." && remarks == "To be added.") {
summ.InnerXml = "Default handler for the <see cref=\"M:" + t + "." + vms [vm] + "\" /> event."; summ.InnerXml = "Default handler for the <see cref=\"M:" + t + "." + vms [vm] + "\" /> event.";
rem.InnerXml = "Override this method in a subclass to provide a default handler for the <see cref=\"M:" + t + "." + vms [vm] + "\" /> event."; rem.InnerXml = "Override this method in a subclass to provide a default handler for the <see cref=\"M:" + t + "." + vms [vm] + "\" /> event.";
dirty = true;
} else } else
Console.WriteLine ("Member had docs:" + vm); Console.WriteLine ("Member had docs:" + vm);
} else { } else {
Console.WriteLine ("Member not found:" + vm); Console.WriteLine ("Member not found:" + vm);
} }
api_doc.Save (filename); if (dirty)
api_doc.Save (filename);
} }
} }
} }