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

* en/Gtk/*ImageData.xml: Removed, see
	bugzilla.ximian.com #70894.
	* en/Gtk/ListStore.xml
	* en/Gtk/MessageDialog.xml
	* en/Gtk/Main.xml
	* en/Gtk/Layout.xml
	* en/Gtk/NodeStore.xml
	* en/Gtk/Label.xml
	* en/Gtk/MatchType.xml
	* en/Gtk/Object.xml: Added docs.


svn path=/trunk/gtk-sharp/; revision=38375
This commit is contained in:
Shane Landrum 2005-01-05 19:34:00 +00:00
parent 1241647a38
commit 1845a8f849
9 changed files with 124 additions and 80 deletions

View file

@ -1,3 +1,16 @@
2005-01-05 Shane Landrum <epicene@pobox.com>
* en/Gtk/*ImageData.xml: Removed, see
bugzilla.ximian.com #70894.
* en/Gtk/ListStore.xml
* en/Gtk/MessageDialog.xml
* en/Gtk/Main.xml
* en/Gtk/Layout.xml
* en/Gtk/NodeStore.xml
* en/Gtk/Label.xml
* en/Gtk/MatchType.xml
* en/Gtk/Object.xml: Added docs.
2005-01-05 Shane Landrum <epicene@pobox.com>
* en/Gtk/Item.xml

View file

@ -672,10 +672,16 @@
<Parameter Name="str1ng" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated.</summary>
<param name="str1ng">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
<remarks>
Checks the string passed as the parameter for underscores,
and then underlines the characters following the
underscores. It will take the first underlined character in
a label and return it as a lower-case accelerator key,
e.g. _Save will return the accelerator key value for "s".
</remarks>
</Docs>
</Member>
<Member MemberName="Get">
@ -688,10 +694,12 @@
<Parameter Name="str" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated; do not use in new code.</summary>
<param name="str">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
<remarks>Gets the current string of text within the Label
object and writes it to <paramref name="str"/>. It does not make a copy of this
string so you must not write to it.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -295,8 +295,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Deprecated. Do not use.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Freeze">
@ -307,8 +307,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Deprecated. Do not use.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Item">
@ -328,4 +328,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -50,9 +50,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<summary>
Returns the number of children that <paramref name="iter"/> has.
</summary>
<returns>an object of type <see cref="T:System.Int32" />, the number of children of <paramref name="iter"/>.</returns>
<remarks>As a special case, if <paramref name="iter"/> is <see langword="null"/>, then the number
of toplevel nodes is returned.</remarks>
</Docs>
</Member>
<Member MemberName="IterChildren">
@ -65,10 +68,23 @@
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Sets <paramref name="iter"/> to point to the first child of <paramref name="parent"/>.
</summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>an object of type <see cref="T:System.Boolean" />,
<see langword="true"/>, if <paramref name="child"/> has been set to the first child.</returns>
<remarks>
<para>
If <paramref name="parent"/> has no children,
<see langword="false"/> is returned and <paramref name="iter"/> is set to be invalid. <paramref name="parent"/> will remain a valid
node after this function has been called.
</para>
<para>
If <paramref name="parent"/> is <see langword="null"/> returns the first node, equivalent to
<literal>gtk_tree_model_get_iter_first (tree_model, iter);</literal>
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ChangeSortColumn">
@ -1414,10 +1430,10 @@ The above example creates a new three columns list store. The types of the colum
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.ListStore" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -103,10 +103,10 @@ When your callbacks are invoked, you would typically take some action - for exam
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.Main" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -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>Deprecated. Do not use.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -50,8 +50,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Deprecated. Do not use.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="AllTail">
@ -63,8 +63,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Deprecated. Do not use.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Head">
@ -76,8 +76,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Deprecated. Do not use.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Tail">
@ -89,8 +89,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Deprecated. Do not use.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Exact">
@ -102,8 +102,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Deprecated. Do not use.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Last">
@ -115,8 +115,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Deprecated. Do not use.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>

View file

@ -190,10 +190,10 @@ MessageDialog md = new MessageDialog
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Markup for the message to display in the dialog.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks>Markup should be in Pango markup format. (TODO: check this.)</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View file

@ -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>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>

View file

@ -12,10 +12,10 @@
<Docs>
<summary> Base class for the Gtk object hierarchy.</summary>
<remarks>Base object for the Gtk object hierarchy.
<para>
The differences between Gtk.Object and GLib.<see cref="T:GLib.Object" /> is a historical one, and it matters little in Gtk#.
</para></remarks>
<para>
The difference between Gtk.Object and GLib.<see cref="T:GLib.Object" /> is a historical one, and it matters little in Gtk#.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -55,8 +55,12 @@ The object is only destroyed if all the references to the object are released, t
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Removes the floating reference from a <see
cref="T:Gtk.Object"/>, if it exists; otherwise does
nothing.
</summary>
<remarks>See the <see cref="T:Gtk.Object"/> overview
documentation at the top of the page.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -122,9 +126,12 @@ The object is only destroyed if all the references to the object are released, t
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.IntPtr" /></returns>
<remarks>To be added</remarks>
<summary>
Diagnostic method to print the raw object and its reference count
as debug information.
</summary>
<returns>a <see cref="T:System.IntPtr" />, the internal C data underlying this object.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="OnDestroyed">
@ -203,12 +210,12 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="arg_id" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use in new code.</summary>
<param name="arg_name">a <see cref="T:System.String" /></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_id">a <see cref="T:System.UInt32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Unref">
@ -219,8 +226,8 @@ The object is only destroyed if all the references to the object are released, t
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Deprecated. Do not use.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Ref">
@ -231,9 +238,9 @@ The object is only destroyed if all the references to the object are released, t
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<returns>a <see cref="T:Gtk.Object" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetDataByIdFull">
@ -248,11 +255,11 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="data_id">a <see cref="T:System.Int32" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetData">
@ -265,10 +272,10 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="key">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.IntPtr" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Weakunref">
@ -281,9 +288,9 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="notify" Type="Gtk.DestroyNotify" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RemoveDataById">
@ -296,9 +303,9 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="data_id" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="data_id">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetDataById">
@ -312,10 +319,10 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="data" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="data_id">a <see cref="T:System.Int32" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Weakref">
@ -328,9 +335,9 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="notify" Type="Gtk.DestroyNotify" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RemoveNoNotifyById">
@ -343,9 +350,9 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="key_id" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="key_id">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RemoveData">
@ -358,9 +365,9 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="key">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetDataFull">
@ -375,11 +382,11 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="key">a <see cref="T:System.String" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetData">
@ -393,10 +400,10 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="data" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="key">a <see cref="T:System.String" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetDataById">
@ -409,10 +416,10 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="data_id" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="data_id">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.IntPtr" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RemoveNoNotify">
@ -425,10 +432,10 @@ The object is only destroyed if all the references to the object are released, t
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated. Do not use.</summary>
<param name="key">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>