2005-01-03 Shane Landrum <epicene@pobox.com>

* en/Gtk/DrawingArea.xml
	* en/Gtk/Expander.xml
	* en/Gtk/ComboBox.xml
	* en/Gtk/Style.xml
	* en/Gtk/EntryCompletion.xml
	* en/Gtk/EventBox.xml: Added docs; turned
	some @param to <paramref name="param"/>.


svn path=/trunk/gtk-sharp/; revision=38281
This commit is contained in:
Shane Landrum 2005-01-03 17:38:13 +00:00
parent 9a099d3865
commit 8b2b88122b
7 changed files with 55 additions and 27 deletions

View file

@ -1,3 +1,13 @@
2005-01-03 Shane Landrum <epicene@pobox.com>
* en/Gtk/DrawingArea.xml
* en/Gtk/Expander.xml
* en/Gtk/ComboBox.xml
* en/Gtk/Style.xml
* en/Gtk/EntryCompletion.xml
* en/Gtk/EventBox.xml: Added docs; turned
some @param to <paramref name="param"/>.
2005-01-03 Shane Landrum <epicene@pobox.com> 2005-01-03 Shane Landrum <epicene@pobox.com>
* en/Gtk/DrawGdkArgs.xml * en/Gtk/DrawGdkArgs.xml

View file

@ -286,7 +286,7 @@ class ComboBoxSample
<Parameter Name="expand" Type="System.Boolean" /> <Parameter Name="expand" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Adds the @cell to the end of the combo box.</summary> <summary>Adds the <paramref name="cell"/> to the end of the combo box.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param> <param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param> <param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks> <remarks>

View file

@ -178,10 +178,10 @@ class LayoutSample : DrawingArea
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the size of the drawing area.</summary>
<param name="width">a <see cref="T:System.Int32" /></param> <param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param> <param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -90,7 +90,7 @@ public class DemoEntryCompletion : Window
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Override this method to run operations before object destruction.</summary> <summary>Disposes the resources associated with the object.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -236,10 +236,14 @@ public class DemoEntryCompletion : Window
<Parameter Name="expand" Type="System.Boolean" /> <Parameter Name="expand" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Adds the <paramref name="cell"/> to the end of the entry-completion widget.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param> <param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param> <param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks /> <remarks>
If <paramref name="expand"/> is <see langword="false"/>, then the
<paramref name="cell"/> is allocated no more space than it needs. Any unused space is
divided evenly between cells for which <paramref name="expand"/> is <see langword="true"/>.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PackStart"> <Member MemberName="PackStart">
@ -253,10 +257,14 @@ public class DemoEntryCompletion : Window
<Parameter Name="expand" Type="System.Boolean" /> <Parameter Name="expand" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Packs the <paramref name="cell"/> into the beginning of the entry-completion widget.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param> <param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param> <param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks /> <remarks>
If <paramref name="expand"/> is <see langword="false"/>, then the
<paramref name="cell"/> is allocated no more space than it needs. Any unused space is
divided evenly between cells for which <paramref name="expand"/> is <see langword="true"/>.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddAttribute"> <Member MemberName="AddAttribute">
@ -271,11 +279,18 @@ public class DemoEntryCompletion : Window
<Parameter Name="column" Type="System.Int32" /> <Parameter Name="column" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Adds an attribute mapping to the list in this entry-completion widget.
</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param> <param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="attribute">a <see cref="T:System.String" /></param> <param name="attribute">a <see cref="T:System.String" />, parameter on <paramref name="cell"/> to be set from the value</param>
<param name="column">a <see cref="T:System.Int32" /></param> <param name="column">a <see cref="T:System.Int32" />, column of the model to get a value from.</param>
<remarks /> <remarks>
The <paramref name="column"/> is the column of the model to get a value from, and the <paramref name="attribute"/> is the
parameter on <paramref name="cell"/> to be set from the value. So for example if column 2
of the model contains strings, you could have the "text" attribute of a
<see cref="T:Gtk.EntryCompletion"/> get its values from column 2.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ClearAttributes"> <Member MemberName="ClearAttributes">
@ -288,7 +303,10 @@ public class DemoEntryCompletion : Window
<Parameter Name="cell" Type="Gtk.CellRenderer" /> <Parameter Name="cell" Type="Gtk.CellRenderer" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Clears all existing attributes previously set with
<see cref="M:Gtk.EntryCompletion.SetAttributes"/>.
</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param> <param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<remarks /> <remarks />
</Docs> </Docs>
@ -301,7 +319,7 @@ public class DemoEntryCompletion : Window
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Clears the completion.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>

View file

@ -165,9 +165,9 @@ public class eventbox
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</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>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="VisibleWindow"> <Member MemberName="VisibleWindow">
@ -178,9 +178,9 @@ public class eventbox
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</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>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -320,10 +320,10 @@ Default value: 0
<Parameter Name="label" Type="System.String" /> <Parameter Name="label" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="label">a <see cref="T:System.String" /></param> <param name="label">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.Expander" /></returns> <returns>a <see cref="T:Gtk.Expander" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -584,7 +584,7 @@ color or pixmap specified by this style for <paramref name="state" />.</summary>
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary> Draws a resize grip in the given rectangle on @window using the given parameters. </summary> <summary> Draws a resize grip in the given rectangle on <paramref name="window"/> using the given parameters. </summary>
<param name="style">a <see cref="T:Gtk.Style" /></param> <param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param> <param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:Gtk.StateType" /></param> <param name="state_type">a <see cref="T:Gtk.StateType" /></param>
@ -652,7 +652,7 @@ color or pixmap specified by this style for <paramref name="state" />.</summary>
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Draws a radio button indicator in the given rectangle on @window with the given parameters. <summary>Draws a radio button indicator in the given rectangle on <paramref name="window"/> with the given parameters.
</summary> </summary>
<param name="style">a <see cref="T:Gtk.Style" /></param> <param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param> <param name="window">a <see cref="T:Gdk.Window" /></param>
@ -826,7 +826,7 @@ color or pixmap specified by this style for <paramref name="state" />.</summary>
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Draws an option menu tab (i.e. the up and down pointing arrows) in the given rectangle on @window using the given parameters. <summary>Draws an option menu tab (i.e. the up and down pointing arrows) in the given rectangle on <paramref name="window"/> using the given parameters.
</summary> </summary>
<param name="style">a <see cref="T:Gtk.Style" /></param> <param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param> <param name="window">a <see cref="T:Gdk.Window" /></param>