ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add some automatic docs for the new stuff

Browse source 
svn path=/trunk/gtk-sharp/; revision=43452
This commit is contained in:
John Luke 2005-04-22 17:20:16 +00:00
parent db6b5d036a
commit 8855f7a5a7
62 changed files with 442 additions and 537 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/ChangeLog
View file

@ -1,3 +1,8 @@
2005-04-22 John Luke <john.luke@gmail.com>
* en/*/*.xml: run gen*.exe to fill in some docs
on the new gtk, atk, gdk, and pango stuff for 2.6
2005-04-08 Dan Winship <danw@novell.com> 2005-04-08 Dan Winship <danw@novell.com>
* en/Gtk/Container.xml: document new children stuff * en/Gtk/Container.xml: document new children stuff

12
doc/en/Atk/BoundsChangedArgs.xml
View file

@ -9,8 +9,10 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event data.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Atk.NoOpObject.BoundsChanged" /> event invokes <see cref="T:Atk.BoundsChangedHandler" /> delegates which pass event data via this class.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName> <BaseTypeName>GLib.SignalArgs</BaseTypeName>
@ -24,9 +26,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public Constructor.</summary>
<returns>a <see cref="T:Atk.BoundsChangedArgs" /></returns> <returns>A new <see cref="T:Atk.BoundsChangedArgs" />.</returns>
<remarks>To be added</remarks> <remarks>Create a new <see cref="T:Atk.BoundsChangedArgs" /> instance with this constructor if you need to invoke a <see cref="T:Atk.BoundsChangedHandler" /> delegate.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Bounds"> <Member MemberName="Bounds">

8
doc/en/Atk/BoundsChangedHandler.xml
View file

@ -9,8 +9,12 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event handler.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Atk.NoOpObject.BoundsChanged" /> event utilizes this delegate:</para>
<para>Event data is passed via the <see cref="T:Atk.BoundsChangedArgs" /> parameter.</para>
<para>To attach a <see cref="T:Atk.BoundsChangedHandler" /> to an event, add the BoundsChangedHandler instance to the event. The methods referenced by the BoundsChangedHandler instance are invoked whenever the event is raised, until the BoundsChangedHandler is removed from the event.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>

4
doc/en/Atk/NoOpObject.xml
View file

@ -1931,9 +1931,9 @@
<Parameter Name="bounds" Type="Atk.Rectangle" /> <Parameter Name="bounds" Type="Atk.Rectangle" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Atk.NoOpObject.BoundsChanged" /> event.</summary>
<param name="bounds">a <see cref="T:Atk.Rectangle" /></param> <param name="bounds">a <see cref="T:Atk.Rectangle" /></param>
<remarks>To be added</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Atk.NoOpObject.BoundsChanged" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

17
doc/en/Gdk/PangoRenderer.xml
View file

@ -49,8 +49,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with this <see cref="T:Gdk.PangoRenderer" /> object.</summary>
<remarks>To be added</remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetOverrideColor"> <Member MemberName="SetOverrideColor">
@ -95,10 +96,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gdk.PangoRenderer" /></returns> <returns>a <see cref="T:Gdk.PangoRenderer" /></returns>
<remarks>To be added</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>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -109,10 +110,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gdk.PangoRenderer" /></returns> <returns>a <see cref="T:Gdk.PangoRenderer" /></returns>
<remarks>To be added</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -137,9 +138,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gdk.PangoRenderer" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Screen"> <Member MemberName="Screen">

17
doc/en/Gtk/AboutDialog.xml
View file

@ -39,8 +39,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with this <see cref="T:Gtk.AboutDialog" /> object.</summary>
<remarks>To be added</remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -51,10 +52,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.AboutDialog" /></returns> <returns>a <see cref="T:Gtk.AboutDialog" /></returns>
<remarks>To be added</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>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -65,10 +66,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.AboutDialog" /></returns> <returns>a <see cref="T:Gtk.AboutDialog" /></returns>
<remarks>To be added</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -90,9 +91,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.AboutDialog" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="License"> <Member MemberName="License">

6
doc/en/Gtk/AccelGroup.xml
View file

@ -339,8 +339,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary></summary> <summary>
<remarks></remarks> </summary>
<remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnAccelActivate"> <Member MemberName="OnAccelActivate">

4
doc/en/Gtk/ActionActivatedArgs.xml
View file

@ -41,8 +41,8 @@
<Docs> <Docs>
<summary>The index of the action that was triggered.</summary> <summary>The index of the action that was triggered.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>See <see cref="P:Gtk.ActionActivatedArgs.InsertActionText"/> <remarks>See <see cref="P:Gtk.ActionActivatedArgs.InsertActionText" />
and <see cref="P:Gtk.ActionActivatedArgs.InsertActionMarkup"/> and <see cref="P:Gtk.ActionActivatedArgs.InsertActionMarkup" />
for more context about the index property. for more context about the index property.
</remarks> </remarks>
</Docs> </Docs>

12
doc/en/Gtk/ActivateCursorItemArgs.xml
View file

@ -9,8 +9,10 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event data.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Gtk.IconView.ActivateCursorItem" /> event invokes <see cref="T:Gtk.ActivateCursorItemHandler" /> delegates which pass event data via this class.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName> <BaseTypeName>GLib.SignalArgs</BaseTypeName>
@ -24,9 +26,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public Constructor.</summary>
<returns>a <see cref="T:Gtk.ActivateCursorItemArgs" /></returns> <returns>A new <see cref="T:Gtk.ActivateCursorItemArgs" />.</returns>
<remarks>To be added</remarks> <remarks>Create a new <see cref="T:Gtk.ActivateCursorItemArgs" /> instance with this constructor if you need to invoke a <see cref="T:Gtk.ActivateCursorItemHandler" /> delegate.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

8
doc/en/Gtk/ActivateCursorItemHandler.xml
View file

@ -9,8 +9,12 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event handler.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Gtk.IconView.ActivateCursorItem" /> event utilizes this delegate:</para>
<para>Event data is passed via the <see cref="T:Gtk.ActivateCursorItemArgs" /> parameter.</para>
<para>To attach a <see cref="T:Gtk.ActivateCursorItemHandler" /> to an event, add the ActivateCursorItemHandler instance to the event. The methods referenced by the ActivateCursorItemHandler instance are invoked whenever the event is raised, until the ActivateCursorItemHandler is removed from the event.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>

20
doc/en/Gtk/Alignment.xml
View file

@ -213,7 +213,8 @@
<Docs> <Docs>
<summary>The padding to insert at the left of the child widget.</summary> <summary>The padding to insert at the left of the child widget.</summary>
<returns>a <see cref="T:System.UInt32" /></returns> <returns>a <see cref="T:System.UInt32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BottomPadding"> <Member MemberName="BottomPadding">
@ -226,7 +227,8 @@
<Docs> <Docs>
<summary>The padding to insert at the bottom of the child widget.</summary> <summary>The padding to insert at the bottom of the child widget.</summary>
<returns>a <see cref="T:System.UInt32" /></returns> <returns>a <see cref="T:System.UInt32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TopPadding"> <Member MemberName="TopPadding">
@ -239,7 +241,8 @@
<Docs> <Docs>
<summary>The padding to insert at the top of the child widget.</summary> <summary>The padding to insert at the top of the child widget.</summary>
<returns>a <see cref="T:System.UInt32" /></returns> <returns>a <see cref="T:System.UInt32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RightPadding"> <Member MemberName="RightPadding">
@ -252,7 +255,8 @@
<Docs> <Docs>
<summary>The padding to insert at the right of the child widget.</summary> <summary>The padding to insert at the right of the child widget.</summary>
<returns>a <see cref="T:System.UInt32" /></returns> <returns>a <see cref="T:System.UInt32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetPadding"> <Member MemberName="GetPadding">
@ -276,7 +280,7 @@
<param name="padding_left">a <see cref="T:System.UInt32" /></param> <param name="padding_left">a <see cref="T:System.UInt32" /></param>
<param name="padding_right">a <see cref="T:System.UInt32" /></param> <param name="padding_right">a <see cref="T:System.UInt32" /></param>
<remarks>This is a convenience method. <remarks>This is a convenience method.
See also <see cref="M:Gtk.Alignment.SetPadding"/>.</remarks> See also <see cref="M:Gtk.Alignment.SetPadding" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetPadding"> <Member MemberName="SetPadding">
@ -300,16 +304,16 @@
<param name="padding_left">a <see cref="T:System.UInt32" /></param> <param name="padding_left">a <see cref="T:System.UInt32" /></param>
<param name="padding_right">a <see cref="T:System.UInt32" /></param> <param name="padding_right">a <see cref="T:System.UInt32" /></param>
<remarks> <remarks>
<para> <para>
The padding adds blank space to the vertical or horizontal sides The padding adds blank space to the vertical or horizontal sides
of the widget. For instance, this can be used to indent the child of the widget. For instance, this can be used to indent the child
widget towards the right by adding padding on the left. widget towards the right by adding padding on the left.
</para> </para>
<para> <para>
This is a convenience method; the properties can also This is a convenience method; the properties can also
be set directly. be set directly.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

23
doc/en/Gtk/ButtonBox.xml
View file

@ -144,7 +144,8 @@
<summary>Gets the internal padding of the child widgets.</summary> <summary>Gets the internal padding of the child widgets.</summary>
<param name="ipad_x">a <see cref="T:System.Int32" />, the horizontal value</param> <param name="ipad_x">a <see cref="T:System.Int32" />, the horizontal value</param>
<param name="ipad_y">a <see cref="T:System.Int32" />, the vertical value</param> <param name="ipad_y">a <see cref="T:System.Int32" />, the vertical value</param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetChildSize"> <Member MemberName="SetChildSize">
@ -164,7 +165,8 @@
</summary> </summary>
<param name="min_width">a <see cref="T:System.Int32" /></param> <param name="min_width">a <see cref="T:System.Int32" /></param>
<param name="min_height">a <see cref="T:System.Int32" /></param> <param name="min_height">a <see cref="T:System.Int32" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetChildIpadding"> <Member MemberName="SetChildIpadding">
@ -181,7 +183,8 @@
<summary>Sets the internal padding of the child widgets.</summary> <summary>Sets the internal padding of the child widgets.</summary>
<param name="ipad_x">a <see cref="T:System.Int32" />, the horizontal value</param> <param name="ipad_x">a <see cref="T:System.Int32" />, the horizontal value</param>
<param name="ipad_y">a <see cref="T:System.Int32" />, the vertical value</param> <param name="ipad_y">a <see cref="T:System.Int32" />, the vertical value</param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetChildSize"> <Member MemberName="GetChildSize">
@ -195,13 +198,14 @@
<Parameter Name="min_height" Type="System.Int32&amp;" RefType="out" /> <Parameter Name="min_height" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary> <summary>
Sets the minimum width and height of this button box's Sets the minimum width and height of this button box's
child widgets. child widgets.
</summary> </summary>
<param name="min_width">a <see cref="T:System.Int32" /></param> <param name="min_width">a <see cref="T:System.Int32" /></param>
<param name="min_height">a <see cref="T:System.Int32" /></param> <param name="min_height">a <see cref="T:System.Int32" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Item"> <Member MemberName="Item">
@ -230,10 +234,11 @@
<Parameter Name="child" Type="Gtk.Widget" /> <Parameter Name="child" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Returns whether <paramref name="child"/> should appear in a secondary group of children.</summary> <summary>Returns whether <paramref name="child" /> should appear in a secondary group of children.</summary>
<param name="child">a <see cref="T:Gtk.Widget" /></param> <param name="child">a <see cref="T:Gtk.Widget" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetChildSecondary"> <Member MemberName="SetChildSecondary">
@ -248,12 +253,12 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary> <summary>
Sets whether <paramref name="child"/> should appear in a secondary group of children. Sets whether <paramref name="child" /> should appear in a secondary group of children.
A typical use of a secondary child is the help button in a dialog. A typical use of a secondary child is the help button in a dialog.
</summary> </summary>
<param name="child">a <see cref="T:Gtk.Widget" /></param> <param name="child">a <see cref="T:Gtk.Widget" /></param>
<param name="is_secondary">a <see cref="T:System.Boolean" />: if <param name="is_secondary">a <see cref="T:System.Boolean" />: if
<see langword="true"/>, the <paramref name="child"/> appears in a secondary group of the button box. <see langword="true" />, the <paramref name="child" /> appears in a secondary group of the button box.
</param> </param>
<remarks> <remarks>
This group appears after the other children if the style This group appears after the other children if the style

29
doc/en/Gtk/Calendar.xml
View file

@ -474,7 +474,8 @@ void HandleDaySelected (object obj, EventArgs args)
<Docs> <Docs>
<summary>The selected day as a number between 1 and 31, or 0 to unselect the currently selected day.</summary> <summary>The selected day as a number between 1 and 31, or 0 to unselect the currently selected day.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ShowWeekNumbers"> <Member MemberName="ShowWeekNumbers">
@ -485,9 +486,10 @@ void HandleDaySelected (object obj, EventArgs args)
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>If <see langword="true"/>, week numbers are displayed</summary> <summary>If <see langword="true" />, week numbers are displayed</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ShowDayNames"> <Member MemberName="ShowDayNames">
@ -498,9 +500,10 @@ void HandleDaySelected (object obj, EventArgs args)
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>If <see langword="true"/>, day names are displayed.</summary> <summary>If <see langword="true" />, day names are displayed.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ShowHeading"> <Member MemberName="ShowHeading">
@ -511,9 +514,10 @@ void HandleDaySelected (object obj, EventArgs args)
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>If <see langword="true"/>, a heading is displayed</summary> <summary>If <see langword="true" />, a heading is displayed</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Month"> <Member MemberName="Month">
@ -526,7 +530,8 @@ void HandleDaySelected (object obj, EventArgs args)
<Docs> <Docs>
<summary>The selected month as a number between 0 and 11.</summary> <summary>The selected month as a number between 0 and 11.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Year"> <Member MemberName="Year">
@ -539,7 +544,8 @@ void HandleDaySelected (object obj, EventArgs args)
<Docs> <Docs>
<summary>The selected year.</summary> <summary>The selected year.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="NoMonthChange"> <Member MemberName="NoMonthChange">
@ -550,9 +556,10 @@ void HandleDaySelected (object obj, EventArgs args)
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>If <see langword="true"/>, the selected month can not be changed.</summary> <summary>If <see langword="true" />, the selected month can not be changed.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DisplayOptions"> <Member MemberName="DisplayOptions">

4
doc/en/Gtk/CellRenderer.xml
View file

@ -539,10 +539,10 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.CellRenderer.EditingStarted" /> event.</summary>
<param name="editable">a <see cref="T:Gtk.CellEditable" /></param> <param name="editable">a <see cref="T:Gtk.CellEditable" /></param>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.CellRenderer.EditingStarted" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="StopEditing"> <Member MemberName="StopEditing">

17
doc/en/Gtk/CellRendererCombo.xml
View file

@ -33,8 +33,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with this <see cref="T:Gtk.CellRendererCombo" /> object.</summary>
<remarks>To be added</remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -45,10 +46,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.CellRendererCombo" /></returns> <returns>a <see cref="T:Gtk.CellRendererCombo" /></returns>
<remarks>To be added</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>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -59,10 +60,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.CellRendererCombo" /></returns> <returns>a <see cref="T:Gtk.CellRendererCombo" /></returns>
<remarks>To be added</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -84,9 +85,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.CellRendererCombo" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TextColumn"> <Member MemberName="TextColumn">

17
doc/en/Gtk/CellRendererProgress.xml
View file

@ -33,8 +33,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with this <see cref="T:Gtk.CellRendererProgress" /> object.</summary>
<remarks>To be added</remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -45,10 +46,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.CellRendererProgress" /></returns> <returns>a <see cref="T:Gtk.CellRendererProgress" /></returns>
<remarks>To be added</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>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -59,10 +60,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.CellRendererProgress" /></returns> <returns>a <see cref="T:Gtk.CellRendererProgress" /></returns>
<remarks>To be added</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -84,9 +85,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.CellRendererProgress" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Text"> <Member MemberName="Text">

11
doc/en/Gtk/CheckMenuItem.xml
View file

@ -202,7 +202,8 @@
<Docs> <Docs>
<summary>Whether the menu item looks like a radio menu item.</summary> <summary>Whether the menu item looks like a radio menu item.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ShowToggle"> <Member MemberName="ShowToggle">
@ -214,7 +215,8 @@
<Docs> <Docs>
<summary>Whether this menu item can be toggled.</summary> <summary>Whether this menu item can be toggled.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="EmitToggled"> <Member MemberName="EmitToggled">
@ -225,8 +227,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Fires the <see cref="E:Gtk.CheckMenuItem.Toggle"/> event.</summary> <summary>Fires the <see cref="E:Gtk.CheckMenuItem.Toggle" /> event.</summary>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

4
doc/en/Gtk/Clipboard.xml
View file

@ -391,9 +391,9 @@
<Parameter Name="evnt" Type="Gdk.EventOwnerChange&amp;" RefType="ref" /> <Parameter Name="evnt" Type="Gdk.EventOwnerChange&amp;" RefType="ref" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.Clipboard.OwnerChange" /> event.</summary>
<param name="evnt">a <see cref="T:Gdk.EventOwnerChange" /></param> <param name="evnt">a <see cref="T:Gdk.EventOwnerChange" /></param>
<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>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="WaitForImage"> <Member MemberName="WaitForImage">

8
doc/en/Gtk/ComboBox.xml
View file

@ -726,8 +726,8 @@ Default value: 0
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.ComboBox.EditingDone" /> 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.ComboBox.EditingDone" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnWidgetRemoved"> <Member MemberName="OnWidgetRemoved">
@ -738,8 +738,8 @@ Default value: 0
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.ComboBox.WidgetRemoved" /> 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.ComboBox.WidgetRemoved" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

22
doc/en/Gtk/Container.xml
View file

@ -535,24 +535,24 @@
<summary>Obtains an array of the container's (non-internal) children.</summary> <summary>Obtains an array of the container's (non-internal) children.</summary>
<returns>An array of non-internal children.</returns> <returns>An array of non-internal children.</returns>
<remarks> <remarks>
<para> <para>
Returns the container's non-internal children; that is, generally, the Returns the container's non-internal children; that is, generally, the
children that were explicitly added to the container by the application, as children that were explicitly added to the container by the application, as
opposed to those widgets that are internal implementation details of the opposed to those widgets that are internal implementation details of the
container. container.
</para> </para>
<para> <para>
If you simply want to do a <see langword="foreach" /> loop on the If you simply want to do a <see langword="foreach" /> loop on the
container's children, you do not need to use the Children property. container's children, you do not need to use the Children property.
Just do: Just do:
</para> </para>
<example> <example>
<code lang="C#"> <code lang="C#">
foreach (Widget w in myContainer) { foreach (Widget w in myContainer) {
// Do something with w // Do something with w
} }
</code> </code>
</example> </example>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -567,19 +567,19 @@ foreach (Widget w in myContainer) {
<summary>Returns an <see cref="T:System.Collections.IEnumerator" /> for the container's children</summary> <summary>Returns an <see cref="T:System.Collections.IEnumerator" /> for the container's children</summary>
<returns>a <see cref="T:System.Collections.IEnumerator" /></returns> <returns>a <see cref="T:System.Collections.IEnumerator" /></returns>
<remarks> <remarks>
<para> <para>
<see cref="T:Gtk.Container" /> implements <see cref="T:Gtk.Container" /> implements
<see cref="T:System.Collections.IEnumerable" />, so you can iterate <see cref="T:System.Collections.IEnumerable" />, so you can iterate
through its children like this: through its children like this:
</para> </para>
<example> <example>
<code lang="C#"> <code lang="C#">
foreach (Widget w in myContainer) { foreach (Widget w in myContainer) {
// Do something with w // Do something with w
} }
</code> </code>
</example> </example>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AllChildren"> <Member MemberName="AllChildren">

6
doc/en/Gtk/DisconnectProxyArgs.xml
View file

@ -41,7 +41,8 @@
<Docs> <Docs>
<summary>The action being disconnected from a proxy.</summary> <summary>The action being disconnected from a proxy.</summary>
<returns>a <see cref="T:Gtk.Action" /></returns> <returns>a <see cref="T:Gtk.Action" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Proxy"> <Member MemberName="Proxy">
@ -54,7 +55,8 @@
<Docs> <Docs>
<summary>The proxy from which an action is being disconnected.</summary> <summary>The proxy from which an action is being disconnected.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns> <returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

12
doc/en/Gtk/EditingStartedArgs.xml
View file

@ -9,8 +9,10 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event data.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Gtk.CellRenderer.EditingStarted" /> event invokes <see cref="T:Gtk.EditingStartedHandler" /> delegates which pass event data via this class.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName> <BaseTypeName>GLib.SignalArgs</BaseTypeName>
@ -24,9 +26,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public Constructor.</summary>
<returns>a <see cref="T:Gtk.EditingStartedArgs" /></returns> <returns>A new <see cref="T:Gtk.EditingStartedArgs" />.</returns>
<remarks>To be added</remarks> <remarks>Create a new <see cref="T:Gtk.EditingStartedArgs" /> instance with this constructor if you need to invoke a <see cref="T:Gtk.EditingStartedHandler" /> delegate.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Editable"> <Member MemberName="Editable">

8
doc/en/Gtk/EditingStartedHandler.xml
View file

@ -9,8 +9,12 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event handler.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Gtk.CellRenderer.EditingStarted" /> event utilizes this delegate:</para>
<para>Event data is passed via the <see cref="T:Gtk.EditingStartedArgs" /> parameter.</para>
<para>To attach a <see cref="T:Gtk.EditingStartedHandler" /> to an event, add the EditingStartedHandler instance to the event. The methods referenced by the EditingStartedHandler instance are invoked whenever the event is raised, until the EditingStartedHandler is removed from the event.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>

4
doc/en/Gtk/Entry.xml
View file

@ -1138,8 +1138,8 @@ The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.Entry.Backspace" /> 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.Entry.Backspace" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="LayoutIndexToTextIndex"> <Member MemberName="LayoutIndexToTextIndex">

4
doc/en/Gtk/EntryCompletion.xml
View file

@ -565,10 +565,10 @@ public class DemoEntryCompletion : Window
<Parameter Name="prefix" Type="System.String" /> <Parameter Name="prefix" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.EntryCompletion.PrefixInserted" /> event.</summary>
<param name="prefix">a <see cref="T:System.String" /></param> <param name="prefix">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.EntryCompletion.PrefixInserted" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InsertPrefix"> <Member MemberName="InsertPrefix">

6
doc/en/Gtk/EventBox.xml
View file

@ -167,7 +167,8 @@ public class eventbox
<Docs> <Docs>
<summary>Whether the event-trapping window of the eventbox is above the window of the child widget as opposed to below it.</summary> <summary>Whether the event-trapping window of the eventbox is above the window of the child widget as opposed to below it.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="VisibleWindow"> <Member MemberName="VisibleWindow">
@ -180,7 +181,8 @@ public class eventbox
<Docs> <Docs>
<summary>Whether the event box is visible, as opposed to invisible and only used to trap events.</summary> <summary>Whether the event box is visible, as opposed to invisible and only used to trap events.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

17
doc/en/Gtk/FileChooserButton.xml
View file

@ -39,8 +39,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with this <see cref="T:Gtk.FileChooserButton" /> object.</summary>
<remarks>To be added</remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -51,10 +52,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.FileChooserButton" /></returns> <returns>a <see cref="T:Gtk.FileChooserButton" /></returns>
<remarks>To be added</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>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -65,10 +66,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.FileChooserButton" /></returns> <returns>a <see cref="T:Gtk.FileChooserButton" /></returns>
<remarks>To be added</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -127,9 +128,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.FileChooserButton" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Title"> <Member MemberName="Title">

38
doc/en/Gtk/FontButton.xml
View file

@ -10,7 +10,8 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>A button to launch a font selection dialog.</summary> <summary>A button to launch a font selection dialog.</summary>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Button</BaseTypeName> <BaseTypeName>Gtk.Button</BaseTypeName>
@ -89,7 +90,8 @@
<Docs> <Docs>
<summary>Public constructor.</summary> <summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.FontButton" /></returns> <returns>a <see cref="T:Gtk.FontButton" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -103,7 +105,8 @@
<summary>Public constructor with a font name.</summary> <summary>Public constructor with a font name.</summary>
<param name="fontname">a <see cref="T:System.String" />, name of font to display in font selection dialog.</param> <param name="fontname">a <see cref="T:System.String" />, name of font to display in font selection dialog.</param>
<returns>a <see cref="T:Gtk.FontButton" /></returns> <returns>a <see cref="T:Gtk.FontButton" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -127,9 +130,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>If this property is <see langword="true"/>, the font size will be displayed along with the name of the selected font.</summary> <summary>If this property is <see langword="true" />, the font size will be displayed along with the name of the selected font.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UseSize"> <Member MemberName="UseSize">
@ -141,10 +145,10 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary> <summary>
If this property is set to <see langword="true"/>, the selected font size will be shown in the label. If this property is set to <see langword="true" />, the selected font size will be shown in the label.
</summary> </summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>For a more WYSIWYG way to show the selected size, see the <see cref="P:Gtk.FontButton.UseSize"/> property.</remarks> <remarks>For a more WYSIWYG way to show the selected size, see the <see cref="P:Gtk.FontButton.UseSize" /> property.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FontName"> <Member MemberName="FontName">
@ -157,7 +161,8 @@
<Docs> <Docs>
<summary>Retrieves the name of the currently selected font.</summary> <summary>Retrieves the name of the currently selected font.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UseFont"> <Member MemberName="UseFont">
@ -170,7 +175,8 @@
<Docs> <Docs>
<summary>Whether the label is drawn in the selected font.</summary> <summary>Whether the label is drawn in the selected font.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Title"> <Member MemberName="Title">
@ -183,7 +189,8 @@
<Docs> <Docs>
<summary>The title of the font dialog.</summary> <summary>The title of the font dialog.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ShowStyle"> <Member MemberName="ShowStyle">
@ -196,7 +203,8 @@
<Docs> <Docs>
<summary>Returns whether the name of the font style will be shown in the label.</summary> <summary>Returns whether the name of the font style will be shown in the label.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FontSet"> <Member MemberName="FontSet">
@ -208,7 +216,8 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Event fired when the font is set.</summary> <summary>Event fired when the font is set.</summary>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetFontName"> <Member MemberName="SetFontName">
@ -224,8 +233,9 @@
<summary>Sets or updates the currently-displayed font in font picker dialog.</summary> <summary>Sets or updates the currently-displayed font in font picker dialog.</summary>
<param name="fontname">a <see cref="T:System.String" />, name of font to display in font selection dialog</param> <param name="fontname">a <see cref="T:System.String" />, name of font to display in font selection dialog</param>
<returns>A string containing the font name if the <returns>A string containing the font name if the
font selection dialog exists, otherwise <see langword="false"/>.</returns> font selection dialog exists, otherwise <see langword="false" />.</returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

19
doc/en/Gtk/IMContext.xml
View file

@ -312,7 +312,7 @@
<param name="cursor_index">a <see cref="T:System.Int32" /></param> <param name="cursor_index">a <see cref="T:System.Int32" /></param>
<remarks> <remarks>
This function is expected to be called in response to the This function is expected to be called in response to the
<see cref="E:Gtk.IMContext.RetrieveSurrounding"/> event, <see cref="E:Gtk.IMContext.RetrieveSurrounding" /> event,
and it will likely have no effect if called at other times. and it will likely have no effect if called at other times.
</remarks> </remarks>
</Docs> </Docs>
@ -333,25 +333,22 @@
<param name="cursor_index">a <see cref="T:System.Int32" /></param> <param name="cursor_index">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
<para> <para>
Input methods typically want context in order to constrain Input methods typically want context in order to constrain
input text based on existing text; this is important for input text based on existing text; this is important for
languages such as Thai where only some sequences of languages such as Thai where only some sequences of
characters are allowed. characters are allowed.
</para> </para>
<para> <para>
This function is implemented by emitting the <see This function is implemented by emitting the <see cref="E:Gtk.IMContext.RetrieveSurrounding" /> event on the
cref="E:Gtk.IMContext.RetrieveSurrounding"/> event on the
input method; in response to this signal, a widget should input method; in response to this signal, a widget should
provide as much context as is available, up to an entire provide as much context as is available, up to an entire
paragraph, by calling <see paragraph, by calling <see cref="M:Gtk.IMContext.SetSurrounding" />. Note that there
cref="M:Gtk.IMContext.SetSurrounding"/>. Note that there is no obligation for a widget to respond to the <see cref="E:Gtk.IMContext.RetrieveSurrounding" /> signal, so
is no obligation for a widget to respond to the <see
cref="E:Gtk.IMContext.RetrieveSurrounding"/> signal, so
input methods must be prepared to function without input methods must be prepared to function without
context. context.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -482,7 +479,7 @@
<param name="str">a <see cref="T:System.String" />, a location to store , the retrieved string.</param> <param name="str">a <see cref="T:System.String" />, a location to store , the retrieved string.</param>
<param name="attrs">a <see cref="T:Pango.AttrList" />, location to store the retrieved attribute list.</param> <param name="attrs">a <see cref="T:Pango.AttrList" />, location to store the retrieved attribute list.</param>
<returns>a <see cref="T:System.Int32" />, the position of the cursor (in bytes) within the preedit string.</returns> <returns>a <see cref="T:System.Int32" />, the position of the cursor (in bytes) within the preedit string.</returns>
<remarks> <remarks>
This string should be displayed inserted at the insertion This string should be displayed inserted at the insertion
point. point.
</remarks> </remarks>

8
doc/en/Gtk/IMContextSimple.xml
View file

@ -110,13 +110,13 @@
<param name="n_seqs">a <see cref="T:System.Int32" /></param> <param name="n_seqs">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.UInt16" /></returns> <returns>a <see cref="T:System.UInt16" /></returns>
<remarks> <remarks>
<para> <para>
Each row of the table consists of <paramref name="max_seq_len"/> key symbols followed by two <see cref="T:System.UInt16" /> interpreted as the high and low words of a Unicode value. Tables are searched starting from the last added. Each row of the table consists of <paramref name="max_seq_len" /> key symbols followed by two <see cref="T:System.UInt16" /> interpreted as the high and low words of a Unicode value. Tables are searched starting from the last added.
</para> </para>
<para> <para>
The table must be sorted in dictionary order on the numeric value of the key symbol fields. (Values beyond the length of the sequence should be zero.) The table must be sorted in dictionary order on the numeric value of the key symbol fields. (Values beyond the length of the sequence should be zero.)
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

49
doc/en/Gtk/IconView.xml
View file

@ -39,8 +39,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with this <see cref="T:Gtk.IconView" /> object.</summary>
<remarks>To be added</remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnSelectionChanged"> <Member MemberName="OnSelectionChanged">
@ -51,8 +52,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.IconView.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.IconView.SelectionChanged" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnAllUnselected"> <Member MemberName="OnAllUnselected">
@ -63,8 +64,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.IconView.AllUnselected" /> 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.IconView.AllUnselected" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnItemActivated"> <Member MemberName="OnItemActivated">
@ -77,9 +78,9 @@
<Parameter Name="path" Type="Gtk.TreePath" /> <Parameter Name="path" Type="Gtk.TreePath" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.IconView.ItemActivated" /> event.</summary>
<param name="path">a <see cref="T:Gtk.TreePath" /></param> <param name="path">a <see cref="T:Gtk.TreePath" /></param>
<remarks>To be added</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.IconView.ItemActivated" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnAllSelected"> <Member MemberName="OnAllSelected">
@ -90,8 +91,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.IconView.AllSelected" /> 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.IconView.AllSelected" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnToggleCursorItem"> <Member MemberName="OnToggleCursorItem">
@ -102,8 +103,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.IconView.ToggleCursorItem" /> 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.IconView.ToggleCursorItem" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnMoveCursor"> <Member MemberName="OnMoveCursor">
@ -117,11 +118,11 @@
<Parameter Name="count" Type="System.Int32" /> <Parameter Name="count" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.IconView.MoveCursor" /> event.</summary>
<param name="step">a <see cref="T:System.Int32" /></param> <param name="step">a <see cref="T:System.Int32" /></param>
<param name="count">a <see cref="T:System.Int32" /></param> <param name="count">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.IconView.MoveCursor" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnActivateCursorItem"> <Member MemberName="OnActivateCursorItem">
@ -132,9 +133,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.IconView.ActivateCursorItem" /> event.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.IconView.ActivateCursorItem" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnSelectCursorItem"> <Member MemberName="OnSelectCursorItem">
@ -145,8 +146,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.IconView.SelectCursorItem" /> 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.IconView.SelectCursorItem" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UnselectAll"> <Member MemberName="UnselectAll">
@ -275,10 +276,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.IconView" /></returns> <returns>a <see cref="T:Gtk.IconView" /></returns>
<remarks>To be added</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>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -289,10 +290,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.IconView" /></returns> <returns>a <see cref="T:Gtk.IconView" /></returns>
<remarks>To be added</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -328,9 +329,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.IconView" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SelectionMode"> <Member MemberName="SelectionMode">

5
doc/en/Gtk/Item.xml
View file

@ -218,9 +218,10 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Deletes all widgets constructed from the specified path.</summary> <summary>Deletes all widgets constructed from the specified path.</summary>
<param name="ifactory_path">a <see cref="T:System.String" />, a factory path to prepend to <paramref name="path"/>. May be <see langword="null"/> if <paramref name="path"/> starts with a factory path.</param> <param name="ifactory_path">a <see cref="T:System.String" />, a factory path to prepend to <paramref name="path" />. May be <see langword="null" /> if <paramref name="path" /> starts with a factory path.</param>
<param name="path">a <see cref="T:System.String" />, a path</param> <param name="path">a <see cref="T:System.String" />, a path</param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

12
doc/en/Gtk/ItemActivatedArgs.xml
View file

@ -9,8 +9,10 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event data.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Gtk.IconView.ItemActivated" /> event invokes <see cref="T:Gtk.ItemActivatedHandler" /> delegates which pass event data via this class.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName> <BaseTypeName>GLib.SignalArgs</BaseTypeName>
@ -24,9 +26,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public Constructor.</summary>
<returns>a <see cref="T:Gtk.ItemActivatedArgs" /></returns> <returns>A new <see cref="T:Gtk.ItemActivatedArgs" />.</returns>
<remarks>To be added</remarks> <remarks>Create a new <see cref="T:Gtk.ItemActivatedArgs" /> instance with this constructor if you need to invoke a <see cref="T:Gtk.ItemActivatedHandler" /> delegate.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Path"> <Member MemberName="Path">

8
doc/en/Gtk/ItemActivatedHandler.xml
View file

@ -9,8 +9,12 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event handler.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Gtk.IconView.ItemActivated" /> event utilizes this delegate:</para>
<para>Event data is passed via the <see cref="T:Gtk.ItemActivatedArgs" /> parameter.</para>
<para>To attach a <see cref="T:Gtk.ItemActivatedHandler" /> to an event, add the ItemActivatedHandler instance to the event. The methods referenced by the ItemActivatedHandler instance are invoked whenever the event is raised, until the ItemActivatedHandler is removed from the event.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>

6
doc/en/Gtk/MatchSelectedArgs.xml
View file

@ -41,7 +41,8 @@
<Docs> <Docs>
<summary>The tree model that contains the selected match.</summary> <summary>The tree model that contains the selected match.</summary>
<returns>a <see cref="T:Gtk.TreeModel" /></returns> <returns>a <see cref="T:Gtk.TreeModel" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Iter"> <Member MemberName="Iter">
@ -54,7 +55,8 @@
<Docs> <Docs>
<summary>An iterator to point at the selected match within the model.</summary> <summary>An iterator to point at the selected match within the model.</summary>
<returns>a <see cref="T:Gtk.TreeIter" /></returns> <returns>a <see cref="T:Gtk.TreeIter" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

21
doc/en/Gtk/MenuToolButton.xml
View file

@ -39,8 +39,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with this <see cref="T:Gtk.MenuToolButton" /> object.</summary>
<remarks>To be added</remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnShowMenu"> <Member MemberName="OnShowMenu">
@ -51,8 +52,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.MenuToolButton.ShowMenu" /> 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.MenuToolButton.ShowMenu" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetArrowTooltip"> <Member MemberName="SetArrowTooltip">
@ -82,10 +83,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.MenuToolButton" /></returns> <returns>a <see cref="T:Gtk.MenuToolButton" /></returns>
<remarks>To be added</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>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -96,10 +97,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.MenuToolButton" /></returns> <returns>a <see cref="T:Gtk.MenuToolButton" /></returns>
<remarks>To be added</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -140,9 +141,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.MenuToolButton" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Menu"> <Member MemberName="Menu">

5
doc/en/Gtk/NoExposeEventArgs.xml
View file

@ -40,9 +40,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>The <see cref="T:Gdk.Event" /> which triggered the <see cref="T:Gtk.Widget.NoExposeEvent"/>.</summary> <summary>The <see cref="T:Gdk.Event" /> which triggered the <see cref="T:Gtk.Widget.NoExposeEvent" />.</summary>
<returns>a <see cref="T:Gdk.Event" /></returns> <returns>a <see cref="T:Gdk.Event" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

56
doc/en/Gtk/Object.xml
View file

@ -14,8 +14,7 @@
<remarks>Base object for the Gtk object hierarchy. <remarks>Base object for the Gtk object hierarchy.
<para> <para>
The difference between Gtk.Object and GLib.<see cref="T:GLib.Object" /> is a historical one, and it matters little in Gtk#. The difference between Gtk.Object and GLib.<see cref="T:GLib.Object" /> is a historical one, and it matters little in Gtk#.
</para> </para></remarks>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Object</BaseTypeName> <BaseTypeName>GLib.Object</BaseTypeName>
@ -55,11 +54,10 @@ The object is only destroyed if all the references to the object are released, t
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Removes the floating reference from a <see <summary>Removes the floating reference from a <see cref="T:Gtk.Object" />, if it exists; otherwise does
cref="T:Gtk.Object"/>, if it exists; otherwise does
nothing. nothing.
</summary> </summary>
<remarks>See the <see cref="T:Gtk.Object"/> overview <remarks>See the <see cref="T:Gtk.Object" /> overview
documentation at the top of the page.</remarks> documentation at the top of the page.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -131,7 +129,8 @@ The object is only destroyed if all the references to the object are released, t
as debug information. as debug information.
</summary> </summary>
<returns>a <see cref="T:System.IntPtr" />, the internal C data underlying this object.</returns> <returns>a <see cref="T:System.IntPtr" />, the internal C data underlying this object.</returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnDestroyed"> <Member MemberName="OnDestroyed">
@ -215,7 +214,8 @@ The object is only destroyed if all the references to the object are released, t
<param name="arg_type">a <see cref="T:GLib.GType" /></param> <param name="arg_type">a <see cref="T:GLib.GType" /></param>
<param name="arg_flags">a <see cref="T:System.UInt32" /></param> <param name="arg_flags">a <see cref="T:System.UInt32" /></param>
<param name="arg_id">a <see cref="T:System.UInt32" /></param> <param name="arg_id">a <see cref="T:System.UInt32" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Unref"> <Member MemberName="Unref">
@ -227,7 +227,8 @@ The object is only destroyed if all the references to the object are released, t
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Ref"> <Member MemberName="Ref">
@ -240,7 +241,8 @@ The object is only destroyed if all the references to the object are released, t
<Docs> <Docs>
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<returns>a <see cref="T:Gtk.Object" /></returns> <returns>a <see cref="T:Gtk.Object" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetDataByIdFull"> <Member MemberName="SetDataByIdFull">
@ -259,7 +261,8 @@ The object is only destroyed if all the references to the object are released, t
<param name="data_id">a <see cref="T:System.Int32" /></param> <param name="data_id">a <see cref="T:System.Int32" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param> <param name="data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param> <param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetData"> <Member MemberName="GetData">
@ -275,7 +278,8 @@ The object is only destroyed if all the references to the object are released, t
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<param name="key">a <see cref="T:System.String" /></param> <param name="key">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.IntPtr" /></returns> <returns>a <see cref="T:System.IntPtr" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Weakunref"> <Member MemberName="Weakunref">
@ -290,7 +294,8 @@ The object is only destroyed if all the references to the object are released, t
<Docs> <Docs>
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param> <param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RemoveDataById"> <Member MemberName="RemoveDataById">
@ -305,7 +310,8 @@ The object is only destroyed if all the references to the object are released, t
<Docs> <Docs>
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<param name="data_id">a <see cref="T:System.Int32" /></param> <param name="data_id">a <see cref="T:System.Int32" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetDataById"> <Member MemberName="SetDataById">
@ -322,7 +328,8 @@ The object is only destroyed if all the references to the object are released, t
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<param name="data_id">a <see cref="T:System.Int32" /></param> <param name="data_id">a <see cref="T:System.Int32" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param> <param name="data">a <see cref="T:System.IntPtr" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Weakref"> <Member MemberName="Weakref">
@ -337,7 +344,8 @@ The object is only destroyed if all the references to the object are released, t
<Docs> <Docs>
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param> <param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RemoveNoNotifyById"> <Member MemberName="RemoveNoNotifyById">
@ -352,7 +360,8 @@ The object is only destroyed if all the references to the object are released, t
<Docs> <Docs>
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<param name="key_id">a <see cref="T:System.Int32" /></param> <param name="key_id">a <see cref="T:System.Int32" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RemoveData"> <Member MemberName="RemoveData">
@ -367,7 +376,8 @@ The object is only destroyed if all the references to the object are released, t
<Docs> <Docs>
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<param name="key">a <see cref="T:System.String" /></param> <param name="key">a <see cref="T:System.String" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetDataFull"> <Member MemberName="SetDataFull">
@ -386,7 +396,8 @@ The object is only destroyed if all the references to the object are released, t
<param name="key">a <see cref="T:System.String" /></param> <param name="key">a <see cref="T:System.String" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param> <param name="data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param> <param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetData"> <Member MemberName="SetData">
@ -403,7 +414,8 @@ The object is only destroyed if all the references to the object are released, t
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<param name="key">a <see cref="T:System.String" /></param> <param name="key">a <see cref="T:System.String" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param> <param name="data">a <see cref="T:System.IntPtr" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetDataById"> <Member MemberName="GetDataById">
@ -419,7 +431,8 @@ The object is only destroyed if all the references to the object are released, t
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<param name="data_id">a <see cref="T:System.Int32" /></param> <param name="data_id">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.IntPtr" /></returns> <returns>a <see cref="T:System.IntPtr" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RemoveNoNotify"> <Member MemberName="RemoveNoNotify">
@ -434,7 +447,8 @@ The object is only destroyed if all the references to the object are released, t
<Docs> <Docs>
<summary>Deprecated. Do not use.</summary> <summary>Deprecated. Do not use.</summary>
<param name="key">a <see cref="T:System.String" /></param> <param name="key">a <see cref="T:System.String" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

12
doc/en/Gtk/OwnerChangeArgs.xml
View file

@ -9,8 +9,10 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event data.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Gtk.Clipboard.OwnerChange" /> event invokes <see cref="T:Gtk.OwnerChangeHandler" /> delegates which pass event data via this class.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName> <BaseTypeName>GLib.SignalArgs</BaseTypeName>
@ -24,9 +26,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public Constructor.</summary>
<returns>a <see cref="T:Gtk.OwnerChangeArgs" /></returns> <returns>A new <see cref="T:Gtk.OwnerChangeArgs" />.</returns>
<remarks>To be added</remarks> <remarks>Create a new <see cref="T:Gtk.OwnerChangeArgs" /> instance with this constructor if you need to invoke a <see cref="T:Gtk.OwnerChangeHandler" /> delegate.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Event"> <Member MemberName="Event">

8
doc/en/Gtk/OwnerChangeHandler.xml
View file

@ -9,8 +9,12 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event handler.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Gtk.Clipboard.OwnerChange" /> event utilizes this delegate:</para>
<para>Event data is passed via the <see cref="T:Gtk.OwnerChangeArgs" /> parameter.</para>
<para>To attach a <see cref="T:Gtk.OwnerChangeHandler" /> to an event, add the OwnerChangeHandler instance to the event. The methods referenced by the OwnerChangeHandler instance are invoked whenever the event is raised, until the OwnerChangeHandler is removed from the event.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>

13
doc/en/Gtk/Paned.xml
View file

@ -144,7 +144,8 @@ public Widget GetExampleFrame()
<param name="allocation">A <see cref="T:System.Int32" /></param> <param name="allocation">A <see cref="T:System.Int32" /></param>
<param name="child1_req">A <see cref="T:System.Int32" /></param> <param name="child1_req">A <see cref="T:System.Int32" /></param>
<param name="child2_req">A <see cref="T:System.Int32" /></param> <param name="child2_req">A <see cref="T:System.Int32" /></param>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -223,8 +224,8 @@ public Widget GetExampleFrame()
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Whether the position property (related to <see cref="P:Gtk.Paned.MinPosition"/> and <summary>Whether the position property (related to <see cref="P:Gtk.Paned.MinPosition" /> and
<see cref="P:Gtk.Paned.MaxPosition"/>) should be used.</summary> <see cref="P:Gtk.Paned.MaxPosition" />) should be used.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param> <param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns> <returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks /> <remarks />
@ -458,7 +459,8 @@ public Widget GetExampleFrame()
This property is derived from the size and shrinkability of the widget's children. This property is derived from the size and shrinkability of the widget's children.
</summary> </summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="MinPosition"> <Member MemberName="MinPosition">
@ -473,7 +475,8 @@ public Widget GetExampleFrame()
This property is derived from the size and shrinkability of the widget's children. This property is derived from the size and shrinkability of the widget's children.
</summary> </summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Item"> <Member MemberName="Item">

22
doc/en/Gtk/Plug.xml
View file

@ -12,13 +12,10 @@
<Docs> <Docs>
<summary>Toplevel for embedding into other processes.</summary> <summary>Toplevel for embedding into other processes.</summary>
<remarks> <remarks>
Together with <see cref="T:Gtk.Socket" />, <see Together with <see cref="T:Gtk.Socket" />, <see cref="T:Gtk.Plug" /> provides the ability to embed widgets from
cref="T:Gtk.Plug"/> provides the ability to embed widgets from
one process into another process in a fashion that is one process into another process in a fashion that is
transparent to the user. One process creates a <see transparent to the user. One process creates a <see cref="T:Gtk.Socket" /> widget and, passes the ID of that widgets
cref="T:Gtk.Socket" /> widget and, passes the ID of that widgets window to the other process, which then creates a <see cref="T:Gtk.Plug " /> with that window ID. Any widgets
window to the other process, which then creates a <see
cref="T:Gtk.Plug " /> with that window ID. Any widgets
contained in the <see cref="T:Gtk.Plug" /> then will appear contained in the <see cref="T:Gtk.Plug" /> then will appear
inside the first applications window. inside the first applications window.
</remarks> </remarks>
@ -125,7 +122,8 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Fired when the plug window is reparented to the socket window.</summary> <summary>Fired when the plug window is reparented to the socket window.</summary>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ConstructForDisplay"> <Member MemberName="ConstructForDisplay">
@ -140,7 +138,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Finish the initialization of the plug identified by <summary>Finish the initialization of the plug identified by
<paramref name="socket_id"/> which is currently displayed on <paramref name="display"/>. <paramref name="socket_id" /> which is currently displayed on <paramref name="display" />.
</summary> </summary>
<param name="display">a <see cref="T:Gdk.Display" /></param> <param name="display">a <see cref="T:Gdk.Display" /></param>
<param name="socket_id">a <see cref="T:System.UInt32" /></param> <param name="socket_id">a <see cref="T:System.UInt32" /></param>
@ -158,9 +156,10 @@
<Docs> <Docs>
<summary>Public constructor.</summary> <summary>Public constructor.</summary>
<param name="display">a <see cref="T:Gdk.Display" /></param> <param name="display">a <see cref="T:Gdk.Display" /></param>
<param name="socket_id">a <see cref="T:System.UInt32" />, the ID of the socket to connect to on <paramref name="display"/>.</param> <param name="socket_id">a <see cref="T:System.UInt32" />, the ID of the socket to connect to on <paramref name="display" />.</param>
<returns>a <see cref="T:Gtk.Plug" /></returns> <returns>a <see cref="T:Gtk.Plug" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -210,7 +209,8 @@
<Docs> <Docs>
<summary>Protected constructor.</summary> <summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.Plug" /></returns> <returns>a <see cref="T:Gtk.Plug" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

9
doc/en/Gtk/PopupContextMenuArgs.xml
View file

@ -41,7 +41,8 @@
<Docs> <Docs>
<summary>The X location at which the context menu was popped up.</summary> <summary>The X location at which the context menu was popped up.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Y"> <Member MemberName="Y">
@ -54,7 +55,8 @@
<Docs> <Docs>
<summary>The Y location at which the context menu was popped up.</summary> <summary>The Y location at which the context menu was popped up.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ButtonNumber"> <Member MemberName="ButtonNumber">
@ -67,7 +69,8 @@
<Docs> <Docs>
<summary>The mouse button number which was used to pop up the context menu.</summary> <summary>The mouse button number which was used to pop up the context menu.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

3
doc/en/Gtk/PostActivateArgs.xml
View file

@ -41,7 +41,8 @@
<Docs> <Docs>
<summary>The action that was activated.</summary> <summary>The action that was activated.</summary>
<returns>a <see cref="T:Gtk.Action" /></returns> <returns>a <see cref="T:Gtk.Action" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

12
doc/en/Gtk/PrefixInsertedArgs.xml
View file

@ -9,8 +9,10 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event data.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Gtk.EntryCompletion.PrefixInserted" /> event invokes <see cref="T:Gtk.PrefixInsertedHandler" /> delegates which pass event data via this class.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName> <BaseTypeName>GLib.SignalArgs</BaseTypeName>
@ -24,9 +26,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public Constructor.</summary>
<returns>a <see cref="T:Gtk.PrefixInsertedArgs" /></returns> <returns>A new <see cref="T:Gtk.PrefixInsertedArgs" />.</returns>
<remarks>To be added</remarks> <remarks>Create a new <see cref="T:Gtk.PrefixInsertedArgs" /> instance with this constructor if you need to invoke a <see cref="T:Gtk.PrefixInsertedHandler" /> delegate.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Prefix"> <Member MemberName="Prefix">

8
doc/en/Gtk/PrefixInsertedHandler.xml
View file

@ -9,8 +9,12 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Event handler.</summary>
<remarks>To be added</remarks> <remarks>
<para>The <see cref="M:Gtk.EntryCompletion.PrefixInserted" /> event utilizes this delegate:</para>
<para>Event data is passed via the <see cref="T:Gtk.PrefixInsertedArgs" /> parameter.</para>
<para>To attach a <see cref="T:Gtk.PrefixInsertedHandler" /> to an event, add the PrefixInsertedHandler instance to the event. The methods referenced by the PrefixInsertedHandler instance are invoked whenever the event is raised, until the PrefixInsertedHandler is removed from the event.</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>

4
doc/en/Gtk/Range.xml
View file

@ -301,11 +301,11 @@
<Parameter Name="new_value" Type="System.Double" /> <Parameter Name="new_value" Type="System.Double" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.Range.ChangeValue" /> event.</summary>
<param name="scroll">a <see cref="T:System.Int32" /></param> <param name="scroll">a <see cref="T:System.Int32" /></param>
<param name="new_value">a <see cref="T:System.Double" /></param> <param name="new_value">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Range.ChangeValue" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

1
doc/en/Gtk/RetrieveSurroundingHandler.xml
View file

@ -15,7 +15,6 @@
<para> <para>
Handlers of this class should set the input method surrounding context by calling <see cref="T:Gtk.IMContext.SetSurrounding" />. The method returns %TRUE if the signal was handled by the callback. Handlers of this class should set the input method surrounding context by calling <see cref="T:Gtk.IMContext.SetSurrounding" />. The method returns %TRUE if the signal was handled by the callback.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
<Base> <Base>

5
doc/en/Gtk/Scale.xml
View file

@ -190,7 +190,8 @@
<Docs> <Docs>
<summary>Gets the <see cref="T:Pango.Layout" /> used to display the scale. </summary> <summary>Gets the <see cref="T:Pango.Layout" /> used to display the scale. </summary>
<returns>a <see cref="T:Pango.Layout" /></returns> <returns>a <see cref="T:Pango.Layout" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetLayoutOffsets"> <Member MemberName="GetLayoutOffsets">
@ -213,7 +214,7 @@
<remarks> <remarks>
Remember that when working with Pango you need to convert to Remember that when working with Pango you need to convert to
and from pixels using PANGO_PIXELS() or <see cref="F:Pango.Scale.PangoScale" />. and from pixels using PANGO_PIXELS() or <see cref="F:Pango.Scale.PangoScale" />.
If <see cref="P:Gtk.Scale.DrawValue" /> is <see langword="false"/>, the return values are If <see cref="P:Gtk.Scale.DrawValue" /> is <see langword="false" />, the return values are
undefined. undefined.
</remarks> </remarks>
</Docs> </Docs>

4
doc/en/Gtk/TextView.xml
View file

@ -1390,8 +1390,8 @@ class TextViewSample
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default handler for the <see cref="M:Gtk.TextView.Backspace" /> 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.TextView.Backspace" /> event.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetIterAtPosition"> <Member MemberName="GetIterAtPosition">

27
doc/en/Gtk/ToggleAction.xml
View file

@ -10,7 +10,8 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>An action which can be toggled between two states</summary> <summary>An action which can be toggled between two states</summary>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Action</BaseTypeName> <BaseTypeName>Gtk.Action</BaseTypeName>
@ -58,8 +59,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Fires the <see cref="E:Gtk.ToggleAction.Toggled"/> event.</summary> <summary>Fires the <see cref="E:Gtk.ToggleAction.Toggled" /> event.</summary>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -85,10 +87,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Internal constructor</summary> <summary>Internal constructor</summary>
label displayed in menu items and on buttons <param name="raw">a <see cref="T:System.IntPtr" /></param> label displayed in menu items and on buttons <param name="raw">a <see cref="T:System.IntPtr" /></param><returns>a <see cref="T:Gtk.ToggleAction" /></returns><remarks>This is not typically used by C# code.</remarks></Docs>
<returns>a <see cref="T:Gtk.ToggleAction" /></returns>
<remarks>This is not typically used by C# code.</remarks>
</Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ToggleAction (string name, string label, string tooltip, string stock_id);" /> <MemberSignature Language="C#" Value="public ToggleAction (string name, string label, string tooltip, string stock_id);" />
@ -107,7 +106,8 @@ label displayed in menu items and on buttons <param name="raw">a <see cre
<param name="tooltip">a <see cref="T:System.String" />, a tooltip for the action</param> <param name="tooltip">a <see cref="T:System.String" />, a tooltip for the action</param>
<param name="stock_id">a <see cref="T:System.String" />, the stock icon to display in widgets representing the action</param> <param name="stock_id">a <see cref="T:System.String" />, the stock icon to display in widgets representing the action</param>
<returns>a <see cref="T:Gtk.ToggleAction" /></returns> <returns>a <see cref="T:Gtk.ToggleAction" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -135,7 +135,8 @@ label displayed in menu items and on buttons <param name="raw">a <see cre
Whether the action should have proxies like a radio action. Whether the action should have proxies like a radio action.
</summary> </summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Active"> <Member MemberName="Active">
@ -147,8 +148,9 @@ label displayed in menu items and on buttons <param name="raw">a <see cre
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Sets the checked state on the toggle action.</summary> <summary>Sets the checked state on the toggle action.</summary>
<returns>a <see cref="T:System.Boolean" />, <see langword="true"/> if checked</returns> <returns>a <see cref="T:System.Boolean" />, <see langword="true" /> if checked</returns>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Toggled"> <Member MemberName="Toggled">
@ -160,7 +162,8 @@ label displayed in menu items and on buttons <param name="raw">a <see cre
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Event fired when the toggle is changed.</summary> <summary>Event fired when the toggle is changed.</summary>
<remarks></remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

2
doc/en/Gtk/TreeModelFilter.xml
View file

@ -1094,7 +1094,7 @@ in a <see cref="T:Gtk.TreeModel" /> for display.</summary>
<summary>Sets the visible function used when filtering to be <paramref name="func" />.</summary> <summary>Sets the visible function used when filtering to be <paramref name="func" />.</summary>
<param name="func">a <see cref="T:Gtk.TreeModelFilterVisibleFunc" /></param> <param name="func">a <see cref="T:Gtk.TreeModelFilterVisibleFunc" /></param>
<remarks> <remarks>
The function should return <see langword="true"/> if the given row should be visible. The function should return <see langword="true" /> if the given row should be visible.
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>

2
doc/en/Gtk/Widget.xml
View file

@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<Type Name="Widget" FullName="Gtk.Widget"> <Type Name="Widget" FullName="Gtk.Widget">
<TypeSignature Language="C#" Value="public class Widget : Gtk.Object, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" /> <TypeSignature Language="C#" Value="public class Widget : Gtk.Object, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>

17
doc/en/Pango/FcDecoder.xml
View file

@ -33,8 +33,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with this <see cref="T:Pango.FcDecoder" /> object.</summary>
<remarks>To be added</remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetGlyph"> <Member MemberName="GetGlyph">
@ -63,10 +64,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Pango.FcDecoder" /></returns> <returns>a <see cref="T:Pango.FcDecoder" /></returns>
<remarks>To be added</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>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -77,10 +78,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Pango.FcDecoder" /></returns> <returns>a <see cref="T:Pango.FcDecoder" /></returns>
<remarks>To be added</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -102,9 +103,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Pango.FcDecoder" />.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

17
doc/en/Pango/Renderer.xml
View file

@ -33,8 +33,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with this <see cref="T:Pango.Renderer" /> object.</summary>
<remarks>To be added</remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawLayout"> <Member MemberName="DrawLayout">
@ -268,10 +269,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Pango.Renderer" /></returns> <returns>a <see cref="T:Pango.Renderer" /></returns>
<remarks>To be added</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>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -282,10 +283,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Pango.Renderer" /></returns> <returns>a <see cref="T:Pango.Renderer" /></returns>
<remarks>To be added</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -307,9 +308,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Pango.Renderer" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Matrix"> <Member MemberName="Matrix">

17
doc/en/Pango/XftRenderer.xml
View file

@ -33,8 +33,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes the resources associated with this <see cref="T:Pango.XftRenderer" /> object.</summary>
<remarks>To be added</remarks> <remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -45,10 +46,10 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Pango.XftRenderer" /></returns> <returns>a <see cref="T:Pango.XftRenderer" /></returns>
<remarks>To be added</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>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -59,10 +60,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Pango.XftRenderer" /></returns> <returns>a <see cref="T:Pango.XftRenderer" /></returns>
<remarks>To be added</remarks> <remarks>This is not typically used by C# code.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -73,9 +74,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Pango.XftRenderer" />.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DefaultColor"> <Member MemberName="DefaultColor">

103
doc/gen-finalize-docs.cs
View file

@ -102,107 +102,4 @@ namespace GtkSharp.Docs
} }
} }
} }
// gen-finalize-docs.cs - Generate documentation for Finalize method.
//
// Author: John Luke <john.luke@gmail.com>
//
// Copyright (c) 2004 Novell, Inc.
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of version 2 of the GNU General Public
// License as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public
// License along with this program; if not, write to the
// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
// Boston, MA 02111-1307, USA.
namespace GtkSharp.Docs
{
using System;
using System.Collections;
using System.IO;
using System.Reflection;
using System.Xml;
using System.Xml.XPath;
public class GenFinalizeDocs
{
public static int Main (string[] args)
{
XmlDocument api_doc = new XmlDocument ();
foreach (string arg in args)
{
Assembly assembly;
try
{
assembly = Assembly.LoadFile (arg);
}
catch (XmlException e)
{
Console.WriteLine (e);
return 1;
}
foreach (Type t in assembly.GetTypes ())
{
if (!t.IsSubclassOf (typeof (GLib.Object)))
continue;
MethodInfo mi = t.GetMethod ("Finalize", BindingFlags.NonPublic | BindingFlags.Instance);
if (mi == null)
continue;
string filename = "en/" + t.Namespace + "/" + t.Name + ".xml";
try
{
Stream stream = File.OpenRead (filename);
api_doc.Load (stream);
stream.Close ();
Console.WriteLine ("opened:" + filename);
}
catch (XmlException e)
{
Console.WriteLine (e);
return 1;
}
XPathNavigator api_nav = api_doc.CreateNavigator ();
XPathNodeIterator iter = api_nav.Select ("/Type/Members/Member[@MemberName='Finalize']");
if (iter.MoveNext ())
{
XmlElement elem = ((IHasXmlNode)iter.Current).GetNode () as XmlElement;
XmlElement summ = elem ["Docs"] ["summary"];
XmlElement rem = elem ["Docs"] ["remarks"];
string summary = summ.InnerXml;
string remarks = rem.InnerXml;
if (summary == "To be added" && remarks == "To be added")
{
summ.InnerXml = "Disposes the resources associated with this <see cref=\"T:" + t + "\"/> object.";
rem.InnerXml = String.Empty;
}
else
{
Console.WriteLine ("Member had docs: Finalize");
}
}
else
{
Console.WriteLine ("Member not found: Finalize");
}
api_doc.Save (filename);
}
}
return 0;
}
}
}

103
doc/gen-gtype-docs.cs
View file

@ -102,107 +102,4 @@ namespace GtkSharp.Docs
} }
} }
} }
// gen-gtype-docs.cs - Generate documentation for GType property.
//
// Author: John Luke <john.luke@gmail.com>
//
// Copyright (c) 2004 Novell, Inc.
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of version 2 of the GNU General Public
// License as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public
// License along with this program; if not, write to the
// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
// Boston, MA 02111-1307, USA.
namespace GtkSharp.Docs
{
using System;
using System.Collections;
using System.IO;
using System.Reflection;
using System.Xml;
using System.Xml.XPath;
public class GenGtypeDocs
{
public static int Main (string[] args)
{
XmlDocument api_doc = new XmlDocument ();
foreach (string arg in args)
{
Assembly assembly;
try
{
assembly = Assembly.LoadFile (arg);
}
catch (XmlException e)
{
Console.WriteLine (e);
return 1;
}
foreach (Type t in assembly.GetTypes ())
{
if (!t.IsSubclassOf (typeof (GLib.Object)))
continue;
PropertyInfo pi = t.GetProperty ("GType");
if (pi == null)
continue;
string filename = "en/" + t.Namespace + "/" + t.Name + ".xml";
try
{
Stream stream = File.OpenRead (filename);
api_doc.Load (stream);
stream.Close ();
Console.WriteLine ("opened:" + filename);
}
catch (XmlException e)
{
Console.WriteLine (e);
return 1;
}
XPathNavigator api_nav = api_doc.CreateNavigator ();
XPathNodeIterator iter = api_nav.Select ("/Type/Members/Member[@MemberName='GType']");
if (iter.MoveNext ())
{
XmlElement elem = ((IHasXmlNode)iter.Current).GetNode () as XmlElement;
XmlElement summ = elem ["Docs"] ["summary"];
XmlElement rem = elem ["Docs"] ["remarks"];
string summary = summ.InnerXml;
string remarks = rem.InnerXml;
if (summary == "To be added" && remarks == "To be added")
{
summ.InnerXml = "GType Property.";
rem.InnerXml = "Returns the native <see cref=\"T:GLib.GType\" /> value for <see cref=\"T:" + t + "\" />.";
}
else
{
Console.WriteLine ("Member had docs: GType");
}
}
else
{
Console.WriteLine ("Member not found: GType");
}
api_doc.Save (filename);
}
}
return 0;
}
}
}