2004-12-30 Shane Landrum <epicene@pobox.com>

* en/Gtk/FilesAddedArgs.xml
	* en/Gtk/FilePath.xml
	* en/Gtk/FilesRemovedArgs.xml
	* en/Gtk/FileFolder.xml
	* en/Gtk/FilesChangedArgs.xml: Filesystem-handling docs.
	* en/Gtk/ObjectRequestedArgs.xml
	* en/Gtk/MatchSelectedArgs.xml
	* en/Gtk/ChangedArgs.xml
	* en/Gtk/ActionActivatedArgs.xml: Event data docs.


svn path=/trunk/gtk-sharp/; revision=38197
This commit is contained in:
Shane Landrum 2004-12-30 18:53:13 +00:00
parent e35e9720d7
commit 48e294a144
10 changed files with 85 additions and 59 deletions

View file

@ -1,3 +1,15 @@
2004-12-30 Shane Landrum <epicene@pobox.com>
* en/Gtk/FilesAddedArgs.xml
* en/Gtk/FilePath.xml
* en/Gtk/FilesRemovedArgs.xml
* en/Gtk/FileFolder.xml
* en/Gtk/FilesChangedArgs.xml: Filesystem-handling docs.
* en/Gtk/ObjectRequestedArgs.xml
* en/Gtk/MatchSelectedArgs.xml
* en/Gtk/ChangedArgs.xml
* en/Gtk/ActionActivatedArgs.xml: Event data docs.
2004-12-30 Mike Kestner <mkestner@novell.com> 2004-12-30 Mike Kestner <mkestner@novell.com>
* en/Gtk/IterFactoryEntry.xml : fix a make assemble breakage. * en/Gtk/IterFactoryEntry.xml : fix a make assemble breakage.

View file

@ -39,9 +39,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The index of the action that was triggered.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks>See <see cref="P:Gtk.ActionActivatedArgs.InsertActionText"/>
and <see cref="P:Gtk.ActionActivatedArgs.InsertActionMarkup"/>
for more context about the index property.
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The action which has just been activated.</summary>
<returns>a <see cref="T:Gtk.RadioAction" /></returns> <returns>a <see cref="T:Gtk.RadioAction" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -9,8 +9,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Interface to represent a folder in a filesystem.</summary>
<remarks>To be added</remarks> <remarks>See also <see cref="T:Gtk.FileSystem"/>, <see cref="T:Gtk.FileSystemUnix"/>, <see cref="T:Gtk.FileSystemWin32"/>. </remarks>
</Docs> </Docs>
<Base /> <Base />
<Interfaces> <Interfaces>
@ -30,10 +30,10 @@
<Parameter Name="path" Type="Gtk.FilePath" /> <Parameter Name="path" Type="Gtk.FilePath" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets information about the file at <paramref name="path"/>.</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param> <param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:Gtk.FileInfo" /></returns> <returns>a <see cref="T:Gtk.FileInfo" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ListChildren"> <Member MemberName="ListChildren">
@ -46,10 +46,10 @@
<Parameter Name="children" Type="GLib.SList" /> <Parameter Name="children" Type="GLib.SList" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Lists the child files of this folder by placing them in <paramref name="children"/>. </summary>
<param name="children">a <see cref="T:GLib.SList" /></param> <param name="children">a <see cref="T:GLib.SList" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" />, false if there are no children.</returns>
<remarks>To be added</remarks> <remarks>XXX: shouldn't "children" be an "out" parameter?</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IsFinishedLoading"> <Member MemberName="IsFinishedLoading">
@ -60,9 +60,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether this folder's information is fully loaded or not.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Deleted"> <Member MemberName="Deleted">
@ -73,8 +73,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when this folder is deleted.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FilesAdded"> <Member MemberName="FilesAdded">
@ -85,8 +85,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when files are added to this folder.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FilesRemoved"> <Member MemberName="FilesRemoved">
@ -97,8 +97,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when files are removed from this folder.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FilesChanged"> <Member MemberName="FilesChanged">
@ -109,8 +109,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when files are changed in this folder.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FinishedLoading"> <Member MemberName="FinishedLoading">
@ -121,8 +121,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
<remarks>To be added</remarks> Event fired when this folder's information is finished loading.
</summary>
<remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -9,8 +9,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Class for basic information about a file.</summary>
<remarks>To be added</remarks> <remarks>See also <see cref="T:Gtk.FileFolder"/>, which uses this class.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Object</BaseTypeName> <BaseTypeName>GLib.Object</BaseTypeName>
@ -72,9 +72,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.FilePath" /></returns> <returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">

View file

@ -9,8 +9,11 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Arguments for the event fired by
<remarks>To be added</remarks> <see cref="T:Gtk.FileFolder"/>-descended
classes when files are added to a folder:
<see cref="E:Gtk.FileFolder.FilesAdded"/>.</summary>
<remarks></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName> <BaseTypeName>GLib.SignalArgs</BaseTypeName>
@ -24,9 +27,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.FilesAddedArgs" /></returns> <returns>a <see cref="T:Gtk.FilesAddedArgs" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Paths"> <Member MemberName="Paths">
@ -37,9 +40,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The paths of the files that were added to the folder.</summary>
<returns>a <see cref="T:GLib.SList" /></returns> <returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -9,8 +9,11 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Arguments for the event fired by
<remarks>To be added</remarks> <see cref="T:Gtk.FileFolder"/>-descended
classes when files in a folder are changed:
<see cref="E:Gtk.FileFolder.FilesChanged"/>.</summary>
<remarks></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName> <BaseTypeName>GLib.SignalArgs</BaseTypeName>
@ -24,9 +27,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.FilesChangedArgs" /></returns> <returns>a <see cref="T:Gtk.FilesChangedArgs" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Paths"> <Member MemberName="Paths">
@ -37,9 +40,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>A list of the paths of the changed files.</summary>
<returns>a <see cref="T:GLib.SList" /></returns> <returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -9,8 +9,11 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Arguments for the event fired by
<remarks>To be added</remarks> <see cref="T:Gtk.FileFolder"/>-descended
classes when files are removed from a folder:
<see cref="E:Gtk.FileFolder.FilesRemoved"/>.</summary>
<remarks></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName> <BaseTypeName>GLib.SignalArgs</BaseTypeName>
@ -24,9 +27,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.FilesRemovedArgs" /></returns> <returns>a <see cref="T:Gtk.FilesRemovedArgs" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Paths"> <Member MemberName="Paths">
@ -37,9 +40,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The paths of the removed files.</summary>
<returns>a <see cref="T:GLib.SList" /></returns> <returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -39,9 +39,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The tree model that contains the selected match.</summary>
<returns>a <see cref="T:Gtk.TreeModel" /></returns> <returns>a <see cref="T:Gtk.TreeModel" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Iter"> <Member MemberName="Iter">
@ -52,9 +52,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>An iterator to point at the selected match within the model.</summary>
<returns>a <see cref="T:Gtk.TreeIter" /></returns> <returns>a <see cref="T:Gtk.TreeIter" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -42,7 +42,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:Gtk.HTMLEmbedded" /></returns> <returns>a <see cref="T:Gtk.HTMLEmbedded" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>