From 1196cf6732ecb5ca72ba9ec991ae5d308035539a Mon Sep 17 00:00:00 2001
From: Shane Landrum <shane@mono-cvs.ximian.com>
Date: Sun, 2 Jan 2005 23:55:33 +0000
Subject: [PATCH] 2005-01-02 Shane Landrum <epicene@pobox.com>
* en/Gtk/ComboBox.xml
* en/Gtk/CellViewMenuItem.xml
* en/Gtk/CellView.xml
* en/Gtk/CellRendererSepText.xml
* en/Gtk/ConnectProxyArgs.xml
* en/Gtk/Combo.xml
* en/Gtk/CellRendererText.xml
* en/Gtk/CheckMenuItem.xml: Added docs.
svn path=/trunk/gtk-sharp/; revision=38244
---
doc/ChangeLog | 11 +++++
doc/en/Gtk/CellRendererSepText.xml | 10 ++---
doc/en/Gtk/CellRendererText.xml | 15 ++++---
doc/en/Gtk/CellView.xml | 20 ++++-----
doc/en/Gtk/CellViewMenuItem.xml | 20 ++++-----
doc/en/Gtk/CheckMenuItem.xml | 12 ++---
doc/en/Gtk/Combo.xml | 10 ++---
doc/en/Gtk/ComboBox.xml | 72 +++++++++++++++++++++---------
doc/en/Gtk/ConnectProxyArgs.xml | 10 ++---
9 files changed, 112 insertions(+), 68 deletions(-)
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 90c27083d..c490dcc41 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,14 @@
+2005-01-02 Shane Landrum <epicene@pobox.com>
+
+ * en/Gtk/ComboBox.xml
+ * en/Gtk/CellViewMenuItem.xml
+ * en/Gtk/CellView.xml
+ * en/Gtk/CellRendererSepText.xml
+ * en/Gtk/ConnectProxyArgs.xml
+ * en/Gtk/Combo.xml
+ * en/Gtk/CellRendererText.xml
+ * en/Gtk/CheckMenuItem.xml: Added docs.
+
2004-12-31 Shane Landrum <epicene@pobox.com>
* en/Gtk/Button.xml
diff --git a/doc/en/Gtk/CellRendererSepText.xml b/doc/en/Gtk/CellRendererSepText.xml
index bf445b840..6c2e34f24 100644
--- a/doc/en/Gtk/CellRendererSepText.xml
+++ b/doc/en/Gtk/CellRendererSepText.xml
@@ -9,8 +9,8 @@
</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>
<Docs>
- <summary>To be added</summary>
- <remarks>To be added</remarks>
+ <summary>Renders a separator in a cell.</summary>
+ <remarks></remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.CellRendererText</BaseTypeName>
@@ -72,10 +72,10 @@
<ReturnValue />
<Parameters />
<Docs>
- <summary>To be added</summary>
+ <summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.CellRendererSepText" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
</Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gtk/CellRendererText.xml b/doc/en/Gtk/CellRendererText.xml
index 0893024bc..529af4941 100644
--- a/doc/en/Gtk/CellRendererText.xml
+++ b/doc/en/Gtk/CellRendererText.xml
@@ -11,7 +11,7 @@
<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>
<summary>Renders text in a cell</summary>
- <remarks>Used to add text to a <see cref="T:Gtk.TreeView" /></remarks>
+ <remarks>Used to add text to a <see cref="T:Gtk.TreeView" />.</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.CellRenderer</BaseTypeName>
@@ -461,9 +461,9 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added</summary>
+ <summary>Whether or not to keep all text in a single paragraph.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="Language">
@@ -474,10 +474,13 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added</summary>
+ <summary>The language this text is in, as an ISO code. </summary>
<returns>a <see cref="T:System.String" /></returns>
- <remarks>To be added</remarks>
+ <remarks>
+ Pango can use this as a hint when rendering the text. If you
+ don't understand this parameter, you probably don't need it.
+ </remarks>
</Docs>
</Member>
</Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gtk/CellView.xml b/doc/en/Gtk/CellView.xml
index 631ece585..d6f2e9fb2 100644
--- a/doc/en/Gtk/CellView.xml
+++ b/doc/en/Gtk/CellView.xml
@@ -88,11 +88,11 @@
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Sets the value of <paramref name="renderer"/>'s property <paramref name="property"/> to <paramref name="value"/>, then resizes and redraws this cell view.</summary>
<param name="renderer">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="property">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:GLib.Value" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetSizeOfRow">
@@ -127,7 +127,7 @@
<summary>To be added</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="PackEnd">
@@ -144,7 +144,7 @@
<summary>To be added</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="PackStart">
@@ -161,7 +161,7 @@
<summary>To be added</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="AddAttribute">
@@ -180,7 +180,7 @@
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="attribute">a <see cref="T:System.String" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="ClearAttributes">
@@ -195,7 +195,7 @@
<Docs>
<summary>To be added</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="Clear">
@@ -207,7 +207,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@@ -356,8 +356,8 @@
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
<param name="func_data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:System.IntPtr" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
</Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gtk/CellViewMenuItem.xml b/doc/en/Gtk/CellViewMenuItem.xml
index 53ca99ba9..27e2d529c 100644
--- a/doc/en/Gtk/CellViewMenuItem.xml
+++ b/doc/en/Gtk/CellViewMenuItem.xml
@@ -10,7 +10,7 @@
<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>
<summary>To be added</summary>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.MenuItem</BaseTypeName>
@@ -41,7 +41,7 @@
<summary>To be added</summary>
<param name="markup">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.CellViewMenuItem" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="NewWithText">
@@ -57,7 +57,7 @@
<summary>To be added</summary>
<param name="text">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.CellViewMenuItem" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@@ -107,9 +107,9 @@
<ReturnValue />
<Parameters />
<Docs>
- <summary>To be added</summary>
+ <summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.CellViewMenuItem" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@@ -121,11 +121,11 @@
<Parameter Name="path" Type="Gtk.TreePath" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Public constructor.</summary>
<param name="model">a <see cref="T:Gtk.TreeModel" /></param>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<returns>a <see cref="T:Gtk.CellViewMenuItem" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@@ -136,10 +136,10 @@
<Parameter Name="pixbuf" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Public constructor.</summary>
<param name="pixbuf">a <see cref="T:Gdk.Pixbuf" /></param>
<returns>a <see cref="T:Gtk.CellViewMenuItem" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@@ -156,4 +156,4 @@
</Docs>
</Member>
</Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gtk/CheckMenuItem.xml b/doc/en/Gtk/CheckMenuItem.xml
index d995e70da..1b7421c18 100644
--- a/doc/en/Gtk/CheckMenuItem.xml
+++ b/doc/en/Gtk/CheckMenuItem.xml
@@ -200,9 +200,9 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added</summary>
+ <summary>Whether the menu item looks like a radio menu item.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="ShowToggle">
@@ -212,9 +212,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added</summary>
+ <summary>Whether this menu item can be toggled.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="EmitToggled">
@@ -225,9 +225,9 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>Emits the "toggle" signal</summary>
+ <summary>Fires the <see cref="E:Gtk.CheckMenuItem.Toggle"/> event.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gtk/Combo.xml b/doc/en/Gtk/Combo.xml
index ed75ef04c..734cdac2d 100644
--- a/doc/en/Gtk/Combo.xml
+++ b/doc/en/Gtk/Combo.xml
@@ -285,7 +285,7 @@ class ComboSample
<Docs>
<summary>Specifies if the arrow (cursor) keys can be used to step through the items in the list.</summary>
<param name="value">
- <see langword="true" /> if the arrow keys can be used to step through the items in the list.</param>
+ A <see cref="T:System.Boolean" />; <see langword="true" /> if the arrow keys can be used to step through the items in the list.</param>
<returns>
<see langword="true" /> if the arrow keys can be used to step through the items in the list.</returns>
<remarks>This is <see langword="true" /> by default.</remarks>
@@ -329,7 +329,7 @@ class ComboSample
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
- <summary>Protected contstructor.</summary>
+ <summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.Combo" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
@@ -358,11 +358,11 @@ class ComboSample
<Parameter Name="ok_if_empty" Type="System.Boolean" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Whether entered values must already be present in the list.</summary>
<param name="val">a <see cref="T:System.Boolean" /></param>
<param name="ok_if_empty">a <see cref="T:System.Boolean" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
</Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gtk/ComboBox.xml b/doc/en/Gtk/ComboBox.xml
index d18b58638..e23335e44 100644
--- a/doc/en/Gtk/ComboBox.xml
+++ b/doc/en/Gtk/ComboBox.xml
@@ -9,7 +9,7 @@
</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>
<Docs>
- <summary>A widget used to choose from a list of items</summary>
+ <summary>A widget used to choose from a list of items.</summary>
<remarks>
<example>
<code lang="C#">
@@ -220,7 +220,7 @@ class ComboBoxSample
<Docs>
<summary>Sets the current active item to be the one referenced by iter.</summary>
<param name="iter">a <see cref="T:Gtk.TreeIter" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="Popdown">
@@ -266,10 +266,13 @@ class ComboBoxSample
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Re-inserts <paramref name="cell"/> at <paramref name="position"/>.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
- <remarks>To be added</remarks>
+ <remarks>
+ Note that <paramref name="cell"/> has already to be packed
+ into the combo box for this to function properly.
+ </remarks>
</Docs>
</Member>
<Member MemberName="PackEnd">
@@ -283,10 +286,14 @@ class ComboBoxSample
<Parameter Name="expand" Type="System.Boolean" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary></summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
- <remarks>To be added</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>
</Member>
<Member MemberName="PackStart">
@@ -295,15 +302,16 @@ class ComboBoxSample
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
+
<Parameters>
<Parameter Name="cell" Type="Gtk.CellRenderer" />
<Parameter Name="expand" Type="System.Boolean" />
</Parameters>
<Docs>
- <summary>To be added</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="expand">a <see cref="T:System.Boolean" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="AddAttribute">
@@ -318,11 +326,18 @@ class ComboBoxSample
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>
+ Adds an attribute mapping to the list in this combo box.
+ </summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
- <param name="attribute">a <see cref="T:System.String" /></param>
- <param name="column">a <see cref="T:System.Int32" /></param>
- <remarks>To be added</remarks>
+ <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" />, column of the model to get a value from.</param>
+ <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.ComboBox"/> get its values from column 2.
+ </remarks>
</Docs>
</Member>
<Member MemberName="ClearAttributes">
@@ -335,9 +350,12 @@ class ComboBoxSample
<Parameter Name="cell" Type="Gtk.CellRenderer" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>
+ Clears all existing attributes previously set with
+ <see cref="M:Gtk.ComboBox.SetAttributes"/>.
+ </summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="Clear">
@@ -348,8 +366,8 @@ class ComboBoxSample
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added</summary>
- <remarks>To be added</remarks>
+ <summary>Unsets all the mappings on all renderers for this combo box.</summary>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetCellDataFunc">
@@ -363,10 +381,15 @@ class ComboBoxSample
<Parameter Name="func" Type="Gtk.CellLayoutDataFunc" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Sets a data function to use for the combo box.</summary>
<param name="renderer">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
- <remarks>To be added</remarks>
+ <remarks>
+ The data function
+ is used instead of the standard attributes mapping for setting the
+ column value, and should set the value of the cell renderer
+ as appropriate. <paramref name="func"/> may be <see langword="null"/> to remove an older one.
+ </remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@@ -538,13 +561,20 @@ Default value: 0
<Parameter Name="destroy" Type="System.IntPtr" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Sets a data function to use for the combo box.</summary>
+ <param name="renderer">a <see cref="T:Gtk.CellRenderer" /></param>
+ <param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
<param name="func_data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:System.IntPtr" /></param>
- <remarks>To be added</remarks>
+ <remarks>
+ The data function
+ is used instead of the standard attributes mapping for setting the
+ column value, and should set the value of the cell renderer
+ as appropriate. <paramref name="func"/> may be <see langword="null"/> to remove an older one.
+ </remarks>
</Docs>
</Member>
</Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gtk/ConnectProxyArgs.xml b/doc/en/Gtk/ConnectProxyArgs.xml
index a9b7d98c6..8f2b917df 100644
--- a/doc/en/Gtk/ConnectProxyArgs.xml
+++ b/doc/en/Gtk/ConnectProxyArgs.xml
@@ -39,9 +39,9 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added</summary>
+ <summary>The action being connected to a proxy.</summary>
<returns>a <see cref="T:Gtk.Action" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="Proxy">
@@ -52,10 +52,10 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added</summary>
+ <summary>The proxy to which an action is being connected.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
- <remarks>To be added</remarks>
+ <remarks></remarks>
</Docs>
</Member>
</Members>
-</Type>
\ No newline at end of file
+</Type>