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

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

Browse source 
* en/Gtk/DrawGdkArgs.xml
	* en/Gtk/ContainerChild.xml
	* en/Gtk/DestroyNotify.xml
	* en/Gtk/Draw.xml
	* en/Gtk/CellViewMenuItem.xml
	* en/Gtk/CellView.xml
	* en/Gtk/Callback.xml
	* en/Gtk/Container.xml: Added docs.


svn path=/trunk/gtk-sharp/; revision=38275
This commit is contained in:
Shane Landrum 2005-01-03 14:32:42 +00:00
parent 0df8781e8b
commit 9a099d3865
9 changed files with 77 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/ChangeLog
View file

@ -1,3 +1,14 @@
2005-01-03 Shane Landrum <epicene@pobox.com>
* en/Gtk/DrawGdkArgs.xml
* en/Gtk/ContainerChild.xml
* en/Gtk/DestroyNotify.xml
* en/Gtk/Draw.xml
* en/Gtk/CellViewMenuItem.xml
* en/Gtk/CellView.xml
* en/Gtk/Callback.xml
* en/Gtk/Container.xml: Added docs.
2005-01-02 Shane Landrum <epicene@pobox.com>
* en/Gtk/ComboBox.xml: Doc edits.

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

@ -8,7 +8,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>A delegate that can be run over a series of widgets.</summary>
<remarks>Invoked by <see cref="M:Gtk.Container.Forall" />.</remarks>
<remarks>Invoked by <see cref="M:Gtk.Container.Forall" /> and <see cref="M:Gtk.Container.ForeachFull" />.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -29,4 +29,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

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

@ -41,7 +41,7 @@
<Parameter Name="markup" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererText" /> to it, and makes its show <paramref name="markup" />.</summary>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererText" /> to it, and makes it show <paramref name="markup" />.</summary>
<param name="markup">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks />
@ -57,7 +57,7 @@
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererText" /> to it, and makes its show <paramref name="text" />.</summary>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererText" /> to it, and makes it show <paramref name="text" />.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks />

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

@ -38,9 +38,9 @@
<Parameter Name="markup" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="markup">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.CellViewMenuItem" /></returns>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererText" /> to it, and makes it show <paramref name="markup" />.</summary>
<param name="markup">a <see cref="T:System.String" />, some HTML</param>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks></remarks>
</Docs>
</Member>
@ -54,10 +54,10 @@
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new <see cref="T:Gtk.CellView" /> widget, adds a <see cref="T:Gtk.CellRendererText" /> to it, and makes it show <paramref name="text" />.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.CellViewMenuItem" /></returns>
<remarks></remarks>
<returns>a <see cref="T:Gtk.CellView" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">

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

@ -616,12 +616,12 @@
<Parameter Name="notify" Type="Gtk.DestroyNotify" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Runs <paramref name="cb"/> over every item in this container.</summary>
<param name="cb">a <see cref="T:Gtk.Callback" /></param>
<param name="marshal">a <see cref="T:Gtk.CallbackMarshal" /></param>
<param name="callback_data">a <see cref="T:System.IntPtr" /></param>
<param name="callback_data">a <see cref="T:System.IntPtr" />, the data to pass to the callback method.</param>
<param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks></remarks>
<remarks>FIXME: this should be clarified.</remarks>
</Docs>
</Member>
<Member MemberName="Item">
@ -641,4 +641,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

15
doc/en/Gtk/ContainerChild.xml
View file

@ -9,7 +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>
<summary>A mixin class for expressing the relation between a container
widget and its child widget(s).</summary>
<remarks></remarks>
</Docs>
<Base>
@ -27,7 +28,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Protected internal data; the parent container.</summary>
<remarks></remarks>
</Docs>
</Member>
@ -40,7 +41,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Protected internal data; the child widget.</summary>
<remarks></remarks>
</Docs>
</Member>
@ -53,7 +54,7 @@
<Parameter Name="child" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<param name="parent">a <see cref="T:Gtk.Container" /></param>
<param name="child">a <see cref="T:Gtk.Widget" /></param>
<returns>a <see cref="T:Gtk.Container+ContainerChild" /></returns>
@ -68,7 +69,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The parent container.</summary>
<returns>a <see cref="T:Gtk.Container" /></returns>
<remarks></remarks>
</Docs>
@ -81,10 +82,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The child widget.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

10
doc/en/Gtk/DestroyNotify.xml
View file

@ -7,9 +7,11 @@
</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 delegate specifying a function signature.</summary>
<remarks>See <see cref="M:Gtk.ListStore.SetSortFunc" /> for where this
gets used.</remarks>
<summary>A delegate run by some callbacks before object destruction.</summary>
<remarks>Used in <see cref="M:Gtk.ListStore.SetSortFunc" />,
<see cref="M:Gtk.Container.ForeachFull" />, and anywhere else that
a run-before-object-destruction routine is needed in a callback.
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -29,4 +31,4 @@ gets used.</remarks>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

66
doc/en/Gtk/Draw.xml
View file

@ -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>To be added</summary>
<summary>A class for drawing various shapes; mostly obsolete.</summary>
<remarks></remarks>
</Docs>
<Base>
@ -35,7 +35,7 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -64,7 +64,7 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -96,7 +96,7 @@
<Parameter Name="gap_width" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -129,7 +129,7 @@
<Parameter Name="gap_side" Type="Gtk.PositionType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -157,7 +157,7 @@
<Parameter Name="expander_style" Type="Gtk.ExpanderStyle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -182,7 +182,7 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="x">a <see cref="T:System.Int32" /></param>
@ -211,7 +211,7 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -242,7 +242,7 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -271,7 +271,7 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -299,7 +299,7 @@
<Parameter Name="layout" Type="Pango.Layout" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -325,7 +325,7 @@
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -352,7 +352,7 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -381,7 +381,7 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -410,7 +410,7 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -437,7 +437,7 @@
<Parameter Name="str1ng" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -465,7 +465,7 @@
<Parameter Name="orientation" Type="Gtk.Orientation" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -498,7 +498,7 @@
<Parameter Name="gap_width" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -530,7 +530,7 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -558,7 +558,7 @@
<Parameter Name="fill" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -584,7 +584,7 @@
<Parameter Name="x" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -612,7 +612,7 @@
<Parameter Name="orientation" Type="Gtk.Orientation" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete. Do not use.</summary>
<param name="style">a <see cref="T:Gtk.Style" /></param>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="state_type">a <see cref="T:System.Int32" /></param>
@ -641,15 +641,19 @@
<Parameter Name="draw_arrow" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Draws a text caret on <paramref name="drawable"/> at <paramref name="location"/>.
*</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="area">a <see cref="T:Gdk.Rectangle" /></param>
<param name="location">a <see cref="T:Gdk.Rectangle" /></param>
<param name="is_primary">a <see cref="T:System.Boolean" /></param>
<param name="direction">a <see cref="T:System.Int32" /></param>
<param name="draw_arrow">a <see cref="T:System.Boolean" /></param>
<remarks></remarks>
<param name="area">a <see cref="T:Gdk.Rectangle" />, rectangle to which the output is clipped, or <see langword="null"/> if the output should not be clipped</param>
<param name="location">a <see cref="T:Gdk.Rectangle" /> location where to draw the cursor (<paramref name="location"/>.Width is ignored)</param>
<param name="is_primary">a <see cref="T:System.Boolean" />, whether the cursor should be the primary cursor color.</param>
<param name="direction">a <see cref="T:System.Int32" />, whether the cursor is left-to-right or right-to-left. Should never be <see cref="F:Gtk.TextDirection.None"/>.</param>
<param name="draw_arrow">a <see cref="T:System.Boolean" />, <see langword="true"/> to draw a directional arrow on the cursor. Should be <see langword="false"/> unless the cursor is split.</param>
<remarks>
This is not a style function
but merely a convenience function for drawing the standard cursor shape.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -658,10 +662,10 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.Draw" /></returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -66,7 +66,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>An additional argument.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks />
</Docs>
@ -79,10 +79,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>A second additional argument.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>