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

* en/GConf/ChangeSet.xml
	* en/GConf/NoSuchKeyException.xml
	* en/GConf/NotifyEventArgs.xml
	* en/GConf/ClientBase.xml
	* en/GConf/NotifyFuncNative.xml
	* en/GConf/Client.xml: Cleaned up and added docs.


svn path=/trunk/gtk-sharp/; revision=38494
This commit is contained in:
Shane Landrum 2005-01-07 16:04:26 +00:00
parent d7e95b01e6
commit 87843406b7
7 changed files with 54 additions and 44 deletions

View file

@ -1,3 +1,12 @@
2005-01-07 Shane Landrum <epicene@pobox.com>
* en/GConf/ChangeSet.xml
* en/GConf/NoSuchKeyException.xml
* en/GConf/NotifyEventArgs.xml
* en/GConf/ClientBase.xml
* en/GConf/NotifyFuncNative.xml
* en/GConf/Client.xml: Cleaned up and added docs.
2005-01-06 Dan Winship <danw@novell.com> 2005-01-06 Dan Winship <danw@novell.com>
* en/Gtk/StockManager.xml: resurrect and update * en/Gtk/StockManager.xml: resurrect and update

View file

@ -42,8 +42,8 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>Initializes a new ChangeSet object</summary> <summary>Initializes a new ChangeSet object</summary>
<returns>an object of type 'GConf.ChangeSet'</returns> <returns>a <see cref="T:GConf.ChangeSet" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -69,11 +69,11 @@
<Parameter Name="key" Type="System.String" /> <Parameter Name="key" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets the value stored in the changeset under key <paramref name="key"/>.</summary>
<param name="key">a <see cref="T:System.String" /></param> <param name="key">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Object" /></returns> <returns>a <see cref="T:System.Object" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View file

@ -78,7 +78,7 @@ catch (GConf.NoSuchKeyException)
<summary>Registers a notification request.</summary> <summary>Registers a notification request.</summary>
<param name="dir">an object of type <see cref="T:System.String" /></param> <param name="dir">an object of type <see cref="T:System.String" /></param>
<param name="notify">an object of type <see cref="T:GConf.NotifyEventHandler" /></param> <param name="notify">an object of type <see cref="T:GConf.NotifyEventHandler" /></param>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">

View file

@ -10,8 +10,9 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Abstract class; extend this to create objects that behave
<remarks>To be added</remarks> like GConf clients.</summary>
<remarks></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Object</BaseTypeName> <BaseTypeName>System.Object</BaseTypeName>
@ -30,10 +31,10 @@
<Parameter Name="val" Type="System.Object" /> <Parameter Name="val" Type="System.Object" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Set the value stored at key <paramref name="key"/> to <paramref name="value"/>.</summary>
<param name="key">To be added: an object of type 'string'</param> <param name="key">a <see cref="T:System.String" /></param>
<param name="val">To be added: an object of type 'object'</param> <param name="val">a <see cref="T:System.Object" /></param>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Get"> <Member MemberName="Get">
@ -46,10 +47,10 @@
<Parameter Name="key" Type="System.String" /> <Parameter Name="key" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the value stored at key <paramref name="key"/>.</summary>
<param name="key">To be added: an object of type 'string'</param> <param name="key">a <see cref="T:System.String" /></param>
<returns>To be added: an object of type 'object'</returns> <returns>a <see cref="T:System.Object" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -58,10 +59,10 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<returns>a <see cref="T:GConf.ClientBase" /></returns> <returns>a <see cref="T:GConf.ClientBase" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View file

@ -29,9 +29,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<returns>To be added: an object of type 'GConf.NoSuchKeyException'</returns> <returns>a <see cref="T:GConf.NoSuchKeyException" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -42,11 +42,11 @@
<Parameter Name="key" Type="System.String" /> <Parameter Name="key" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="key">To be added: an object of type 'string'</param> <param name="key">a <see cref="T:System.String" />, name of the key that was not found.</param>
<returns>To be added: an object of type 'GConf.NoSuchKeyException'</returns> <returns>a <see cref="T:GConf.NoSuchKeyException" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

View file

@ -11,7 +11,7 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>Arguments of the GConf Notify event that was called due to a GConf key being added, removed or updated.</summary> <summary>Arguments of the GConf Notify event that was called due to a GConf key being added, removed or updated.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.EventArgs</BaseTypeName> <BaseTypeName>System.EventArgs</BaseTypeName>
@ -29,9 +29,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>This constructor is called to initialize a NotifyEventArgs with the key/value that was updated, removed or added in GConf</summary> <summary>This constructor is called to initialize a NotifyEventArgs with the key/value that was updated, removed or added in GConf</summary>
<param name="key">To be added: an object of type 'string'</param> <param name="key">a <see cref="T:System.String" /></param>
<param name="val">To be added: an object of type 'object'</param> <param name="val">a <see cref="T:System.Object" /></param>
<returns>an object of type 'GConf.NotifyEventArgs', event arguments to the NotifyEventHandler delegate</returns> <returns>a <see cref="T:GConf.NotifyEventArgs" />, event arguments to the NotifyEventHandler delegate</returns>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -45,7 +45,7 @@
<summary>This NotifyEventArgs property refers to the GConf Value from an entry which modification, addition or removal cause the event to be fired. <summary>This NotifyEventArgs property refers to the GConf Value from an entry which modification, addition or removal cause the event to be fired.
</summary> </summary>
<returns>the object stored in the GConf which modification, removal or addition cause the event to be fired.</returns> <returns>the object stored in the GConf which modification, removal or addition cause the event to be fired.</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Key"> <Member MemberName="Key">
@ -57,7 +57,7 @@
<Docs> <Docs>
<summary>This NotifyEventArgs property refers to the key which value modification, addition or removal cause the event to be fired.</summary> <summary>This NotifyEventArgs property refers to the key which value modification, addition or removal cause the event to be fired.</summary>
<returns>a string for the key name</returns> <returns>a string for the key name</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

View file

@ -10,8 +10,8 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal class. Do not use.</summary>
<remarks>To be added</remarks> <remarks>Used by <see cref="T:GConf.NotifyWrapper"/>.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>
@ -41,7 +41,7 @@
<Parameter Name="object" Type="System.Object" /> <Parameter Name="object" Type="System.Object" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<param name="client_ptr">a <see cref="T:System.IntPtr" /></param> <param name="client_ptr">a <see cref="T:System.IntPtr" /></param>
<param name="id">a <see cref="T:System.UInt32" /></param> <param name="id">a <see cref="T:System.UInt32" /></param>
<param name="entry_ptr">a <see cref="T:System.IntPtr" /></param> <param name="entry_ptr">a <see cref="T:System.IntPtr" /></param>
@ -49,7 +49,7 @@
<param name="callback">a <see cref="T:System.AsyncCallback" /></param> <param name="callback">a <see cref="T:System.AsyncCallback" /></param>
<param name="object">a <see cref="T:System.Object" /></param> <param name="object">a <see cref="T:System.Object" /></param>
<returns>a <see cref="T:System.IAsyncResult" /></returns> <returns>a <see cref="T:System.IAsyncResult" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="EndInvoke"> <Member MemberName="EndInvoke">
@ -62,9 +62,9 @@
<Parameter Name="result" Type="System.IAsyncResult" /> <Parameter Name="result" Type="System.IAsyncResult" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<param name="result">a <see cref="T:System.IAsyncResult" /></param> <param name="result">a <see cref="T:System.IAsyncResult" /></param>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -76,11 +76,11 @@
<Parameter Name="method" Type="System.IntPtr" /> <Parameter Name="method" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="object">a <see cref="T:System.Object" /></param> <param name="object">a <see cref="T:System.Object" /></param>
<param name="method">a <see cref="T:System.IntPtr" /></param> <param name="method">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:GConf.NotifyFuncNative" /></returns> <returns>a <see cref="T:GConf.NotifyFuncNative" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Invoke"> <Member MemberName="Invoke">
@ -96,13 +96,13 @@
<Parameter Name="user_data" Type="System.IntPtr" /> <Parameter Name="user_data" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal. Do not use.</summary>
<param name="client_ptr">a <see cref="T:System.IntPtr" /></param> <param name="client_ptr">a <see cref="T:System.IntPtr" /></param>
<param name="id">a <see cref="T:System.UInt32" /></param> <param name="id">a <see cref="T:System.UInt32" /></param>
<param name="entry_ptr">a <see cref="T:System.IntPtr" /></param> <param name="entry_ptr">a <see cref="T:System.IntPtr" /></param>
<param name="user_data">a <see cref="T:System.IntPtr" /></param> <param name="user_data">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>