2004-08-29 Shane Landrum <epicene@pobox.com>

* Key.xml
	* KeySnoopFunc.xml: Docs for global hotkeys.
	* Range.xml
	* MoveSliderArgs.xml: Docs for number ranges.
	* Entry.xml
	* Label.xml: Small texty widgets docs.

svn path=/trunk/gtk-sharp/; revision=32984
This commit is contained in:
Shane Landrum 2004-08-29 08:55:30 +00:00
parent 6032cbafcb
commit cba403d2d5
7 changed files with 48 additions and 39 deletions

View File

@ -1,3 +1,12 @@
2004-08-29 Shane Landrum <epicene@pobox.com>
* Key.xml
* KeySnoopFunc.xml: Docs for global hotkeys.
* Range.xml
* MoveSliderArgs.xml: Docs for number ranges.
* Entry.xml
* Label.xml: Small texty widgets docs.
2004-08-29 Shane Landrum <epicene@pobox.com>
* Menu.xml

View File

@ -466,9 +466,9 @@ class EntrySample
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Number of pixels the entry scrolled off the screen to the left.</summary>
<returns>A <see cref="T:System.Int32"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="WidthChars">
@ -702,9 +702,9 @@ class EntrySample
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Fired when the popup handler needs to be filled with data.</summary>
<remarks>
<para>Data pertaining to this event is encapsulated in a <see cref="T:Gtk.PopulatePopupHandler" />.</para>
<para>Data pertaining to this event is encapsulated in a <see cref="T:Gtk.PopulatePopupArgs" />.</para>
</remarks>
</Docs>
</Member>
@ -747,10 +747,10 @@ class EntrySample
<Parameter Name="position" Type="System.Int32&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="new_text">To be added: an object of type 'string'</param>
<param name="position">To be added: an object of type 'int&amp;'</param>
<remarks>To be added</remarks>
<summary>Add text <paramref name="new_text"/> to the entry just before <paramref name="position"/>.</summary>
<param name="new_text">A <see cref="System.String"/></param>
<param name="position">A <see cref="System.Int32&amp;"/></param>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -761,10 +761,10 @@ class EntrySample
<Parameter Name="initialText" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="initialText">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.Entry'</returns>
<remarks>To be added</remarks>
<summary>Public constructor.</summary>
<param name="initialText">A <see cref="System.String"/></param>
<returns>A <see cref="T:Gtk.Entry"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="GetLayoutOffsets">

View File

@ -10,8 +10,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>An object for keys that are independent of keyboard focus--- global hotkeys, which execute <see cref="T:Gtk.KeySnoopFunc"/> functions.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -29,9 +29,9 @@
<Parameter Name="snooper_handler_id" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Remove a snooper with id <paramref name="snooper_handler_id"/></summary>
<param name="snooper_handler_id">a <see cref="T:System.UInt32" /></param>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="SnooperInstall">
@ -44,10 +44,10 @@
<Parameter Name="snooper" Type="Gtk.KeySnoopFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Install a snooper function.</summary>
<param name="snooper">a <see cref="T:Gtk.KeySnoopFunc" /></param>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.UInt32" />, the snooper handler id.</returns>
<remarks>Code that uses this method should hold onto the return value, as it's necessary to disable the key.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -56,10 +56,10 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor.</summary>
<returns>a <see cref="T:Gtk.Key" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

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>To be added</summary>
<remarks>To be added</remarks>
<summary>A function to be invoked by a global hot-key (a <see cref="T:Gtk.Key"/>, regardless of keyboard focus.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -30,4 +30,4 @@
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

@ -644,10 +644,10 @@
<Parameter Name="str" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Basic constructor.</summary>
<param name="str">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.Label" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">

View File

@ -39,10 +39,10 @@
<ReturnType>Gtk.ScrollType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.ScrollType'</returns>
<remarks>To be added</remarks>
<summary>The kind of scrolling that was done in the triggering event.</summary>
<returns>A <see cref="T:Gtk.ScrollType"/></returns>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -168,8 +168,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when the user moves a slider.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="ValueChanged">
@ -194,8 +194,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when the bounds of the range are adjusted.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="GType">
@ -273,10 +273,10 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.Range" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>