From 7f90d3ee7f49ed91d6949c0ecbae68b17a640915 Mon Sep 17 00:00:00 2001
From: John Luke <jluke@mono-cvs.ximian.com>
Date: Fri, 6 Jun 2003 18:41:12 +0000
Subject: [PATCH] add GConf docs

svn path=/trunk/gtk-sharp/; revision=15163
---
 doc/ChangeLog                       |   7 ++
 doc/en/GConf/ChangeSet.xml          |  94 +++++++++++++++++++++++
 doc/en/GConf/Client.xml             | 112 ++++++++++++++++++++++++++++
 doc/en/GConf/ClientBase.xml         |  95 +++++++++++++++++++++++
 doc/en/GConf/NoSuchKeyException.xml |  51 +++++++++++++
 doc/en/GConf/NotifyEventArgs.xml    |  62 +++++++++++++++
 doc/en/GConf/NotifyEventHandler.xml |  28 +++++++
 doc/en/GConf/NotifyFuncNative.xml   |  28 +++++++
 8 files changed, 477 insertions(+)
 create mode 100644 doc/en/GConf/ChangeSet.xml
 create mode 100644 doc/en/GConf/Client.xml
 create mode 100644 doc/en/GConf/ClientBase.xml
 create mode 100644 doc/en/GConf/NoSuchKeyException.xml
 create mode 100644 doc/en/GConf/NotifyEventArgs.xml
 create mode 100644 doc/en/GConf/NotifyEventHandler.xml
 create mode 100644 doc/en/GConf/NotifyFuncNative.xml

diff --git a/doc/ChangeLog b/doc/ChangeLog
index 8f24997d5..f202062e4 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,10 @@
+2003-06-06  John Luke  <jluke@cfl.rr.com>
+	* en/GConf/*.xml: add
+
+2003-06-04  John Luke  <jluke@cfl.rr.com>
+	* en/Gtk/Image.xml: add parameter and returns references
+	* en/Gtk/Window.xml: add parameter and returns references
+
 2003-06-03  John Luke  <jluke@cfl.rr.com>
 	* README: update instructions to compile and install docs
 
diff --git a/doc/en/GConf/ChangeSet.xml b/doc/en/GConf/ChangeSet.xml
new file mode 100644
index 000000000..85fab080b
--- /dev/null
+++ b/doc/en/GConf/ChangeSet.xml
@@ -0,0 +1,94 @@
+<Type Name="ChangeSet" FullName="GConf.ChangeSet">
+  <TypeSignature Language="C#" Value="public class ChangeSet : GConf.ClientBase, IDisposable" Maintainer="auto" />
+  <AssemblyInfo>
+    <AssemblyName>gconf-sharp</AssemblyName>
+    <AssemblyPublicKey />
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+    <AssemblyCulture>neutral</AssemblyCulture>
+    <Attributes />
+  </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>
+  <Docs>
+    <summary>To be added</summary>
+    <remarks>To be added</remarks>
+  </Docs>
+  <Base>
+    <BaseTypeName>GConf.ClientBase</BaseTypeName>
+  </Base>
+  <Interfaces>
+    <Interface>
+      <InterfaceName>System.IDisposable</InterfaceName>
+    </Interface>
+  </Interfaces>
+  <Attributes />
+  <Members>
+    <Member MemberName="Get">
+      <MemberSignature Language="C#" Value="public virtual object Get (string key);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Object</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="key" Type="System.String" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="key">To be added: an object of type 'string'</param>
+        <returns>To be added: an object of type 'object'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="SetValue">
+      <MemberSignature Language="C#" Value="protected virtual void SetValue (string key, GConf.Value val);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="key" Type="System.String" />
+        <Parameter Name="val" Type="GConf.Value" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="key">To be added: an object of type 'string'</param>
+        <param name="val">To be added: an object of type 'GConf.Value'</param>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="Dispose">
+      <MemberSignature Language="C#" Value="public virtual void Dispose ();" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters />
+      <Docs>
+        <summary>To be added</summary>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="Finalize">
+      <MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters />
+      <Docs>
+        <summary>To be added</summary>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName=".ctor">
+      <MemberSignature Language="C#" Value="public ChangeSet ();" />
+      <MemberType>Constructor</MemberType>
+      <ReturnValue />
+      <Parameters />
+      <Docs>
+        <summary>To be added</summary>
+        <returns>To be added: an object of type 'GConf.ChangeSet'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+  </Members>
+</Type>
\ No newline at end of file
diff --git a/doc/en/GConf/Client.xml b/doc/en/GConf/Client.xml
new file mode 100644
index 000000000..ffbec3c35
--- /dev/null
+++ b/doc/en/GConf/Client.xml
@@ -0,0 +1,112 @@
+<Type Name="Client" FullName="GConf.Client">
+  <TypeSignature Language="C#" Value="public class Client : GConf.ClientBase" Maintainer="auto" />
+  <AssemblyInfo>
+    <AssemblyName>gconf-sharp</AssemblyName>
+    <AssemblyPublicKey />
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+    <AssemblyCulture>neutral</AssemblyCulture>
+    <Attributes />
+  </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>
+  <Docs>
+    <summary>To be added</summary>
+    <remarks>To be added</remarks>
+  </Docs>
+  <Base>
+    <BaseTypeName>GConf.ClientBase</BaseTypeName>
+  </Base>
+  <Interfaces />
+  <Attributes />
+  <Members>
+    <Member MemberName="SuggestSync">
+      <MemberSignature Language="C#" Value="public void SuggestSync ();" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters />
+      <Docs>
+        <summary>To be added</summary>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="RemoveNotify">
+      <MemberSignature Language="C#" Value="public void RemoveNotify (string dir, GConf.NotifyEventHandler notify);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="dir" Type="System.String" />
+        <Parameter Name="notify" Type="GConf.NotifyEventHandler" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="dir">To be added: an object of type 'string'</param>
+        <param name="notify">To be added: an object of type 'GConf.NotifyEventHandler'</param>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="AddNotify">
+      <MemberSignature Language="C#" Value="public void AddNotify (string dir, GConf.NotifyEventHandler notify);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="dir" Type="System.String" />
+        <Parameter Name="notify" Type="GConf.NotifyEventHandler" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="dir">To be added: an object of type 'string'</param>
+        <param name="notify">To be added: an object of type 'GConf.NotifyEventHandler'</param>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="Get">
+      <MemberSignature Language="C#" Value="public virtual object Get (string key);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Object</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="key" Type="System.String" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="key">To be added: an object of type 'string'</param>
+        <returns>To be added: an object of type 'object'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="SetValue">
+      <MemberSignature Language="C#" Value="protected virtual void SetValue (string key, GConf.Value val);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="key" Type="System.String" />
+        <Parameter Name="val" Type="GConf.Value" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="key">To be added: an object of type 'string'</param>
+        <param name="val">To be added: an object of type 'GConf.Value'</param>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName=".ctor">
+      <MemberSignature Language="C#" Value="public Client ();" />
+      <MemberType>Constructor</MemberType>
+      <ReturnValue />
+      <Parameters />
+      <Docs>
+        <summary>To be added</summary>
+        <returns>To be added: an object of type 'GConf.Client'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+  </Members>
+</Type>
\ No newline at end of file
diff --git a/doc/en/GConf/ClientBase.xml b/doc/en/GConf/ClientBase.xml
new file mode 100644
index 000000000..97e7c4695
--- /dev/null
+++ b/doc/en/GConf/ClientBase.xml
@@ -0,0 +1,95 @@
+<Type Name="ClientBase" FullName="GConf.ClientBase">
+  <TypeSignature Language="C#" Value="public abstract class ClientBase" Maintainer="auto" />
+  <AssemblyInfo>
+    <AssemblyName>gconf-sharp</AssemblyName>
+    <AssemblyPublicKey />
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+    <AssemblyCulture>neutral</AssemblyCulture>
+    <Attributes />
+  </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>
+  <Docs>
+    <summary>To be added</summary>
+    <remarks>To be added</remarks>
+  </Docs>
+  <Base>
+    <BaseTypeName>System.Object</BaseTypeName>
+  </Base>
+  <Interfaces />
+  <Attributes />
+  <Members>
+    <Member MemberName="Initialize">
+      <MemberSignature Language="C#" Value="protected void Initialize ();" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters />
+      <Docs>
+        <summary>To be added</summary>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="Set">
+      <MemberSignature Language="C#" Value="public void Set (string key, object val);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="key" Type="System.String" />
+        <Parameter Name="val" Type="System.Object" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="key">To be added: an object of type 'string'</param>
+        <param name="val">To be added: an object of type 'object'</param>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="SetValue">
+      <MemberSignature Language="C#" Value="protected virtual void SetValue (string key, GConf.Value val);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="key" Type="System.String" />
+        <Parameter Name="val" Type="GConf.Value" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="key">To be added: an object of type 'string'</param>
+        <param name="val">To be added: an object of type 'GConf.Value'</param>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="Get">
+      <MemberSignature Language="C#" Value="public virtual object Get (string key);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Object</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="key" Type="System.String" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="key">To be added: an object of type 'string'</param>
+        <returns>To be added: an object of type 'object'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName=".ctor">
+      <MemberSignature Language="C#" Value="public ClientBase ();" />
+      <MemberType>Constructor</MemberType>
+      <ReturnValue />
+      <Parameters />
+      <Docs>
+        <summary>To be added</summary>
+        <returns>To be added: an object of type 'GConf.ClientBase'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+  </Members>
+</Type>
\ No newline at end of file
diff --git a/doc/en/GConf/NoSuchKeyException.xml b/doc/en/GConf/NoSuchKeyException.xml
new file mode 100644
index 000000000..a190823ac
--- /dev/null
+++ b/doc/en/GConf/NoSuchKeyException.xml
@@ -0,0 +1,51 @@
+<Type Name="NoSuchKeyException" FullName="GConf.NoSuchKeyException">
+  <TypeSignature Language="C#" Value="public class NoSuchKeyException : System.Exception, ISerializable" Maintainer="auto" />
+  <AssemblyInfo>
+    <AssemblyName>gconf-sharp</AssemblyName>
+    <AssemblyPublicKey />
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+    <AssemblyCulture>neutral</AssemblyCulture>
+    <Attributes />
+  </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>
+  <Docs>
+    <summary>To be added</summary>
+    <remarks>To be added</remarks>
+  </Docs>
+  <Base>
+    <BaseTypeName>System.Exception</BaseTypeName>
+  </Base>
+  <Interfaces>
+    <Interface>
+      <InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>
+    </Interface>
+  </Interfaces>
+  <Attributes />
+  <Members>
+    <Member MemberName=".ctor">
+      <MemberSignature Language="C#" Value="public NoSuchKeyException ();" />
+      <MemberType>Constructor</MemberType>
+      <ReturnValue />
+      <Parameters />
+      <Docs>
+        <summary>To be added</summary>
+        <returns>To be added: an object of type 'GConf.NoSuchKeyException'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName=".ctor">
+      <MemberSignature Language="C#" Value="public NoSuchKeyException (string key);" />
+      <MemberType>Constructor</MemberType>
+      <ReturnValue />
+      <Parameters>
+        <Parameter Name="key" Type="System.String" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="key">To be added: an object of type 'string'</param>
+        <returns>To be added: an object of type 'GConf.NoSuchKeyException'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+  </Members>
+</Type>
\ No newline at end of file
diff --git a/doc/en/GConf/NotifyEventArgs.xml b/doc/en/GConf/NotifyEventArgs.xml
new file mode 100644
index 000000000..d88e8ec4b
--- /dev/null
+++ b/doc/en/GConf/NotifyEventArgs.xml
@@ -0,0 +1,62 @@
+<Type Name="NotifyEventArgs" FullName="GConf.NotifyEventArgs">
+  <TypeSignature Language="C#" Value="public class NotifyEventArgs : System.EventArgs" Maintainer="auto" />
+  <AssemblyInfo>
+    <AssemblyName>gconf-sharp</AssemblyName>
+    <AssemblyPublicKey />
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+    <AssemblyCulture>neutral</AssemblyCulture>
+    <Attributes />
+  </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>
+  <Docs>
+    <summary>To be added</summary>
+    <remarks>To be added</remarks>
+  </Docs>
+  <Base>
+    <BaseTypeName>System.EventArgs</BaseTypeName>
+  </Base>
+  <Interfaces />
+  <Attributes />
+  <Members>
+    <Member MemberName=".ctor">
+      <MemberSignature Language="C#" Value="public NotifyEventArgs (string key, object val);" />
+      <MemberType>Constructor</MemberType>
+      <ReturnValue />
+      <Parameters>
+        <Parameter Name="key" Type="System.String" />
+        <Parameter Name="val" Type="System.Object" />
+      </Parameters>
+      <Docs>
+        <summary>To be added</summary>
+        <param name="key">To be added: an object of type 'string'</param>
+        <param name="val">To be added: an object of type 'object'</param>
+        <returns>To be added: an object of type 'GConf.NotifyEventArgs'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="Value">
+      <MemberSignature Language="C#" Value="public object Value { get; };" />
+      <MemberType>Property</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Object</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added</summary>
+        <returns>To be added: an object of type 'object'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="Key">
+      <MemberSignature Language="C#" Value="public string Key { get; };" />
+      <MemberType>Property</MemberType>
+      <ReturnValue>
+        <ReturnType>System.String</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added</summary>
+        <returns>To be added: an object of type 'string'</returns>
+        <remarks>To be added</remarks>
+      </Docs>
+    </Member>
+  </Members>
+</Type>
\ No newline at end of file
diff --git a/doc/en/GConf/NotifyEventHandler.xml b/doc/en/GConf/NotifyEventHandler.xml
new file mode 100644
index 000000000..807d6fafd
--- /dev/null
+++ b/doc/en/GConf/NotifyEventHandler.xml
@@ -0,0 +1,28 @@
+<Type Name="NotifyEventHandler" FullName="GConf.NotifyEventHandler">
+  <TypeSignature Language="C#" Value="public sealed delegate void NotifyEventHandler (object sender, GConf.NotifyEventArgs args);" Maintainer="auto" />
+  <AssemblyInfo>
+    <AssemblyName>gconf-sharp</AssemblyName>
+    <AssemblyPublicKey />
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+    <AssemblyCulture>neutral</AssemblyCulture>
+    <Attributes />
+  </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>
+  <Docs>
+    <summary>To be added</summary>
+    <remarks>To be added</remarks>
+  </Docs>
+  <Base>
+    <BaseTypeName>System.Delegate</BaseTypeName>
+  </Base>
+  <Interfaces>
+    <Interface>
+      <InterfaceName>System.ICloneable</InterfaceName>
+    </Interface>
+    <Interface>
+      <InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>
+    </Interface>
+  </Interfaces>
+  <Attributes />
+  <Members />
+</Type>
\ No newline at end of file
diff --git a/doc/en/GConf/NotifyFuncNative.xml b/doc/en/GConf/NotifyFuncNative.xml
new file mode 100644
index 000000000..ca3535279
--- /dev/null
+++ b/doc/en/GConf/NotifyFuncNative.xml
@@ -0,0 +1,28 @@
+<Type Name="NotifyFuncNative" FullName="GConf.NotifyFuncNative">
+  <TypeSignature Language="C#" Value="public sealed delegate void NotifyFuncNative (IntPtr client_ptr, uint id, IntPtr entry_ptr, IntPtr user_data);" Maintainer="auto" />
+  <AssemblyInfo>
+    <AssemblyName>gconf-sharp</AssemblyName>
+    <AssemblyPublicKey />
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+    <AssemblyCulture>neutral</AssemblyCulture>
+    <Attributes />
+  </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>
+  <Docs>
+    <summary>To be added</summary>
+    <remarks>To be added</remarks>
+  </Docs>
+  <Base>
+    <BaseTypeName>System.Delegate</BaseTypeName>
+  </Base>
+  <Interfaces>
+    <Interface>
+      <InterfaceName>System.ICloneable</InterfaceName>
+    </Interface>
+    <Interface>
+      <InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>
+    </Interface>
+  </Interfaces>
+  <Attributes />
+  <Members />
+</Type>
\ No newline at end of file