2003-02-24 Kevin Breit <mrproper@ximian.com>

* en/Gtk/ArrowType.xml: Removed the "To be added" from the remarks sections.

	* en/Gtk/Arrow.xml: Fixed up a few things in the documentation.

svn path=/trunk/gtk-sharp/; revision=11940
This commit is contained in:
Kevin Breit 2003-02-25 04:19:38 +00:00
parent 38750dcd9a
commit 9ca9b4a738
3 changed files with 41 additions and 34 deletions

View File

@ -1,3 +1,9 @@
2003-02-24 Kevin Breit <mrproper@ximian.com>
* en/Gtk/ArrowType.xml: Removed the "To be added" from the remarks sections.
* en/Gtk/Arrow.xml: Fixed up a few things in the documentation.
2003-02-23 Duncan Mak <duncan@ximian.com>
* makefile: the docs target is dangerous, remove it by

View File

@ -10,14 +10,28 @@
<summary>Produces an Arrow pointing in one of four cardinal directions.</summary>
<remarks>
<para>
Arrow should be used to draw simple arrows that need to point in one of the four cardinal directions (Up, Down, Left, or Right). The style of the arrow can be one of the following: None, In, Out, EtchedIn and EtchedOut. Note that these directions and style types may be ammended in versions of Gtk to come.
Arrow should be used to draw simple arrows that need to
point in one of the four cardinal directions ( <see
cref="P:Gtk.ArrowType.Up"/>, <see
cref="P:Gtk.ArrowType.Down"/>, <see
cref="P:Gtk.ArrowType.Left"/>, or <see
cref="P:Gtk.ArrowType.Right"/>).
The style of the arrow can
be one of the following: <see cref="P:Gtk.ShadowType.None"/>,
<see cref="P:Gtk.ShadowType.In"/>, <see
cref="P:Gtk.ShadowType.Out"/>, <see
cref="P:Gtk.ShadowType.EtchedIn"/> and <see
cref="P:Gtk.ShadowType.EtchedOut"/>. Note that these directions and style types may be ammended in versions of Gtk to come.
</para>
<para>
Arrow will fill any space alloted to it, but since it is inherited from <see cref="C:Gtk.Misc" />, it can be padded
and/or aligned, fill exactly the space the programmer desires.
Arrow will fill any space alloted to it, but since it is
inherited from <see cref="C:Gtk.Misc" />, it can be padded
and/or aligned, fill exactly the space the programmer
desires.
</para>
<para>
The direction or style of an arrow can be changed after creation by using <see cref="M:Gtk.Arrow.Set" />.
The direction or style of an arrow can be changed after
creation by using <see cref="P:Gtk.Arrow.ArrowType" />.
</para>
</remarks>
</Docs>
@ -41,7 +55,7 @@
<Attributes />
<Members>
<Member MemberName="TypeGetType">
<MemberSignature Language="C#" Value="public static uint TypeGetType ();" />
x <MemberSignature Language="C#" Value="public static uint TypeGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
@ -53,26 +67,6 @@
<remarks />
</Docs>
</Member>
<Member MemberName="Set">
<MemberSignature Language="C#" Value="public void Set (Gtk.ArrowType arrow_type, Gtk.ShadowType shadow_type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="arrow_type" Type="Gtk.ArrowType" />
<Parameter Name="shadow_type" Type="Gtk.ShadowType" />
</Parameters>
<Docs>
<summary>Sets the direction and style of the Arrow.</summary>
<param name="arrow_type">A valid ArrowType.</param>
<param name="shadow_type">A valid ShadowType.</param>
<remarks>
<para>The cardinal directions are: Up, Down, Left and Right.</para>
<para>The shadow types are: None, In, Out, EtchedIn and EtchedOut.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
<MemberType>Method</MemberType>
@ -152,7 +146,7 @@
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.Arrow</summary>
<returns>The GLib TYpe for the Gtk.Arrow class.</returns>
<returns>The GLib Type for the Gtk.Arrow class.</returns>
<remarks />
</Docs>
</Member>
@ -174,7 +168,11 @@
Changes the appearance of an outline typically provided by a <see cref="T:Gtk.Frame" />.
</para>
<para>
The shadow types are: None, In, Out, EtchedIn and EtchedOut.
The shadow types are: <see cref="P:Gtk.ShadowType.None"/>,
<see cref="P:Gtk.ShadowType.In"/>,
<see cref="P:Gtk.ShadowType.Out"/>, <see
cref="P:Gtk.ShadowType.EtchedIn"/> and <see
cref="P:Gtk.ShadowType.EtchedOut"/>.
</para>
</remarks>
</Docs>
@ -197,7 +195,10 @@
Changes the direction of an Arrow.
</para>
<para>
The cardinal directions are: Up, Down, Left and Right.
The cardinal directions are: <see
cref="P:Gtk.ArrowType.Up"/>, <see
cref="P:Gtk.ArrowType.Down"/>, <see
cref="P:Gtk.ArrowType.Left"/> and <see cref="P:Gtk.ArrowType.Right"/>.
</para>
</remarks>
</Docs>

View File

@ -7,8 +7,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>Used to indicate the direction in which a GtkArrow should point.</summary>
<remarks>To be added</remarks>
<summary>Used to indicate the direction in which a <see cref="M:Gtk.Arrow"> should point.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -35,7 +35,7 @@
<Parameters />
<Docs>
<summary>Represents an upward pointing arrow.</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Down">
@ -47,7 +47,7 @@
<Parameters />
<Docs>
<summary>Represents an downward pointing arrow.</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Left">
@ -59,7 +59,7 @@
<Parameters />
<Docs>
<summary>Represents a left pointing arrow.</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Right">
@ -71,7 +71,7 @@
<Parameters />
<Docs>
<summary>Represents a right pointing arrow.</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="value__">