Updated API docs

2005-12-04  Aaron Bockover  <aaron@aaronbock.net>

    * docs/*: Updated API docs

12 files changed, 454 insertions, 2 deletions

diff --git a/docs/.cvsignore b/docs/.cvsignore
new file mode 100644
index 000000000..2220afb5b
--- /dev/null
+++ b/docs/.cvsignore
@@ -0,0 +1,5 @@
+Makefile
+Makefile.in
+banshee-docs.tree
+banshee-docs.zip
+
diff --git a/docs/en/Banshee.Base/Gstreamer.xml b/docs/en/Banshee.Base/Gstreamer.xml
new file mode 100644
index 000000000..c71d4daef
--- /dev/null
+++ b/docs/en/Banshee.Base/Gstreamer.xml
@@ -0,0 +1,61 @@
+<Type Name="Gstreamer" FullName="Banshee.Base.Gstreamer">
+  <TypeSignature Language="C#" Value="public abstract sealed class Gstreamer" />
+  <AssemblyInfo>
+    <AssemblyName>Banshee.Base</AssemblyName>
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+  </AssemblyInfo>
+  <Base>
+    <BaseTypeName>System.Object</BaseTypeName>
+  </Base>
+  <Interfaces />
+  <Members>
+    <Member MemberName="TestEncoder">
+      <MemberSignature Language="C#" Value="public static bool TestEncoder (string pipeline);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Boolean</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="pipeline" Type="System.String" />
+      </Parameters>
+      <Docs>
+        <param name="pipeline">To be added.</param>
+        <summary>To be added.</summary>
+        <returns>To be added.</returns>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="Initialize">
+      <MemberSignature Language="C#" Value="public static 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="DetectMimeType">
+      <MemberSignature Language="C#" Value="public static string DetectMimeType (Uri uri);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.String</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="uri" Type="System.Uri" />
+      </Parameters>
+      <Docs>
+        <param name="uri">To be added.</param>
+        <summary>To be added.</summary>
+        <returns>To be added.</returns>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+  </Members>
+  <Docs>
+    <summary>To be added.</summary>
+    <remarks>To be added.</remarks>
+  </Docs>
+</Type>
diff --git a/docs/en/Banshee.Base/IconThemeUtils.xml b/docs/en/Banshee.Base/IconThemeUtils.xml
new file mode 100644
index 000000000..c9a530814
--- /dev/null
+++ b/docs/en/Banshee.Base/IconThemeUtils.xml
@@ -0,0 +1,67 @@
+<Type Name="IconThemeUtils" FullName="Banshee.Base.IconThemeUtils">
+  <TypeSignature Language="C#" Value="public abstract sealed class IconThemeUtils" />
+  <AssemblyInfo>
+    <AssemblyName>Banshee.Base</AssemblyName>
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+  </AssemblyInfo>
+  <Base>
+    <BaseTypeName>System.Object</BaseTypeName>
+  </Base>
+  <Interfaces />
+  <Members>
+    <Member MemberName="LoadIcon">
+      <MemberSignature Language="C#" Value="public static Gdk.Pixbuf LoadIcon (string name, int size);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>Gdk.Pixbuf</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="name" Type="System.String" />
+        <Parameter Name="size" Type="System.Int32" />
+      </Parameters>
+      <Docs>
+        <param name="name">To be added.</param>
+        <param name="size">To be added.</param>
+        <summary>To be added.</summary>
+        <returns>To be added.</returns>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="SetWindowIcon">
+      <MemberSignature Language="C#" Value="public static void SetWindowIcon (Gtk.Window window);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="window" Type="Gtk.Window" />
+      </Parameters>
+      <Docs>
+        <param name="window">To be added.</param>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="SetWindowIcon">
+      <MemberSignature Language="C#" Value="public static void SetWindowIcon (Gtk.Window window, string iconName);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="window" Type="Gtk.Window" />
+        <Parameter Name="iconName" Type="System.String" />
+      </Parameters>
+      <Docs>
+        <param name="window">To be added.</param>
+        <param name="iconName">To be added.</param>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+  </Members>
+  <Docs>
+    <summary>To be added.</summary>
+    <remarks>To be added.</remarks>
+  </Docs>
+</Type>
diff --git a/docs/en/Banshee.Base/ImportEventArgs.xml b/docs/en/Banshee.Base/ImportEventArgs.xml
new file mode 100644
index 000000000..7c1803bd8
--- /dev/null
+++ b/docs/en/Banshee.Base/ImportEventArgs.xml
@@ -0,0 +1,48 @@
+<Type Name="ImportEventArgs" FullName="Banshee.Base.ImportEventArgs">
+  <TypeSignature Language="C#" Value="public class ImportEventArgs : System.EventArgs" />
+  <AssemblyInfo>
+    <AssemblyName>Banshee.Base</AssemblyName>
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+  </AssemblyInfo>
+  <Base>
+    <BaseTypeName>System.EventArgs</BaseTypeName>
+  </Base>
+  <Interfaces />
+  <Members>
+    <Member MemberName=".ctor">
+      <MemberSignature Language="C#" Value="public ImportEventArgs ();" />
+      <MemberType>Constructor</MemberType>
+      <Parameters />
+      <Docs>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="FileName">
+      <MemberSignature Language="C#" Value="public string FileName;" />
+      <MemberType>Field</MemberType>
+      <ReturnValue>
+        <ReturnType>System.String</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="ReturnMessage">
+      <MemberSignature Language="C#" Value="public string ReturnMessage;" />
+      <MemberType>Field</MemberType>
+      <ReturnValue>
+        <ReturnType>System.String</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+  </Members>
+  <Docs>
+    <summary>To be added.</summary>
+    <remarks>To be added.</remarks>
+  </Docs>
+</Type>
diff --git a/docs/en/Banshee.Base/ImportEventHandler.xml b/docs/en/Banshee.Base/ImportEventHandler.xml
new file mode 100644
index 000000000..30a166ab4
--- /dev/null
+++ b/docs/en/Banshee.Base/ImportEventHandler.xml
@@ -0,0 +1,23 @@
+<Type Name="ImportEventHandler" FullName="Banshee.Base.ImportEventHandler">
+  <TypeSignature Language="C#" Value="public delegate void ImportEventHandler(object o, Banshee.Base.ImportEventArgs args);" />
+  <AssemblyInfo>
+    <AssemblyName>Banshee.Base</AssemblyName>
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+  </AssemblyInfo>
+  <Base>
+    <BaseTypeName>System.Delegate</BaseTypeName>
+  </Base>
+  <Parameters>
+    <Parameter Name="o" Type="System.Object" />
+    <Parameter Name="args" Type="Banshee.Base.ImportEventArgs" />
+  </Parameters>
+  <ReturnValue>
+    <ReturnType>System.Void</ReturnType>
+  </ReturnValue>
+  <Docs>
+    <param name="o">To be added.</param>
+    <param name="args">To be added.</param>
+    <summary>To be added.</summary>
+    <remarks>To be added.</remarks>
+  </Docs>
+</Type>
diff --git a/docs/en/Banshee.Base/ImportManager.xml b/docs/en/Banshee.Base/ImportManager.xml
new file mode 100644
index 000000000..60257ac58
--- /dev/null
+++ b/docs/en/Banshee.Base/ImportManager.xml
@@ -0,0 +1,100 @@
+<Type Name="ImportManager" FullName="Banshee.Base.ImportManager">
+  <TypeSignature Language="C#" Value="public class ImportManager" />
+  <AssemblyInfo>
+    <AssemblyName>Banshee.Base</AssemblyName>
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+  </AssemblyInfo>
+  <Base>
+    <BaseTypeName>System.Object</BaseTypeName>
+  </Base>
+  <Interfaces />
+  <Members>
+    <Member MemberName="ImportRequested">
+      <MemberSignature Language="C#" Value="public event Banshee.Base.ImportEventHandler ImportRequested;" />
+      <MemberType>Event</MemberType>
+      <ReturnValue>
+        <ReturnType>Banshee.Base.ImportEventHandler</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="QueueSource">
+      <MemberSignature Language="C#" Value="public void QueueSource (Banshee.Base.UriList uris);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="uris" Type="Banshee.Base.UriList" />
+      </Parameters>
+      <Docs>
+        <param name="uris">To be added.</param>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="QueueSource">
+      <MemberSignature Language="C#" Value="public void QueueSource (Gtk.SelectionData selection);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="selection" Type="Gtk.SelectionData" />
+      </Parameters>
+      <Docs>
+        <param name="selection">To be added.</param>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="QueueSource">
+      <MemberSignature Language="C#" Value="public void QueueSource (string source);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="source" Type="System.String" />
+      </Parameters>
+      <Docs>
+        <param name="source">To be added.</param>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="QueueSource">
+      <MemberSignature Language="C#" Value="public void QueueSource (string[] paths);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="paths" Type="System.String[]" />
+      </Parameters>
+      <Docs>
+        <param name="paths">To be added.</param>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="Instance">
+      <MemberSignature Language="C#" Value="public static Banshee.Base.ImportManager Instance { get; };" />
+      <MemberType>Property</MemberType>
+      <ReturnValue>
+        <ReturnType>Banshee.Base.ImportManager</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added.</summary>
+        <value>To be added.</value>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+  </Members>
+  <Docs>
+    <summary>To be added.</summary>
+    <remarks>To be added.</remarks>
+  </Docs>
+</Type>
diff --git a/docs/en/Banshee.Base/UriList.xml b/docs/en/Banshee.Base/UriList.xml
new file mode 100644
index 000000000..f025e84cc
--- /dev/null
+++ b/docs/en/Banshee.Base/UriList.xml
@@ -0,0 +1,81 @@
+<Type Name="UriList" FullName="Banshee.Base.UriList">
+  <TypeSignature Language="C#" Value="public class UriList : System.Collections.ArrayList" />
+  <AssemblyInfo>
+    <AssemblyName>Banshee.Base</AssemblyName>
+    <AssemblyVersion>0.0.0.0</AssemblyVersion>
+  </AssemblyInfo>
+  <Base>
+    <BaseTypeName>System.Collections.ArrayList</BaseTypeName>
+  </Base>
+  <Interfaces />
+  <Members>
+    <Member MemberName=".ctor">
+      <MemberSignature Language="C#" Value="public UriList (string[] uris);" />
+      <MemberType>Constructor</MemberType>
+      <Parameters>
+        <Parameter Name="uris" Type="System.String[]" />
+      </Parameters>
+      <Docs>
+        <param name="uris">To be added.</param>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName=".ctor">
+      <MemberSignature Language="C#" Value="public UriList (string data);" />
+      <MemberType>Constructor</MemberType>
+      <Parameters>
+        <Parameter Name="data" Type="System.String" />
+      </Parameters>
+      <Docs>
+        <param name="data">To be added.</param>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName=".ctor">
+      <MemberSignature Language="C#" Value="public UriList (Gtk.SelectionData selection);" />
+      <MemberType>Constructor</MemberType>
+      <Parameters>
+        <Parameter Name="selection" Type="Gtk.SelectionData" />
+      </Parameters>
+      <Docs>
+        <param name="selection">To be added.</param>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="PathToFileUri">
+      <MemberSignature Language="C#" Value="public static Uri PathToFileUri (string path);" />
+      <MemberType>Method</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Uri</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="path" Type="System.String" />
+      </Parameters>
+      <Docs>
+        <param name="path">To be added.</param>
+        <summary>To be added.</summary>
+        <returns>To be added.</returns>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="LocalPaths">
+      <MemberSignature Language="C#" Value="public string[] LocalPaths { get; };" />
+      <MemberType>Property</MemberType>
+      <ReturnValue>
+        <ReturnType>System.String[]</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added.</summary>
+        <value>To be added.</value>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+  </Members>
+  <Docs>
+    <summary>To be added.</summary>
+    <remarks>To be added.</remarks>
+  </Docs>
+</Type>
diff --git a/docs/en/Banshee.Dap/DapCore.xml b/docs/en/Banshee.Dap/DapCore.xml
index 8db1b0e01..038556012 100644
--- a/docs/en/Banshee.Dap/DapCore.xml
+++ b/docs/en/Banshee.Dap/DapCore.xml
@@ -55,6 +55,18 @@
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
+    <Member MemberName="Dispose">
+      <MemberSignature Language="C#" Value="public static 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>
   </Members>
   <Docs>
     <summary>To be added.</summary>
diff --git a/docs/en/Banshee.Dap/DapDevice.xml b/docs/en/Banshee.Dap/DapDevice.xml
index 90f5233b1..038f3bc66 100644
--- a/docs/en/Banshee.Dap/DapDevice.xml
+++ b/docs/en/Banshee.Dap/DapDevice.xml
@@ -1,5 +1,5 @@
 <Type Name="DapDevice" FullName="Banshee.Dap.DapDevice">
-  <TypeSignature Language="C#" Value="public abstract class DapDevice : System.Collections.IEnumerable" />
+  <TypeSignature Language="C#" Value="public abstract class DapDevice : System.Collections.IEnumerable, System.IDisposable" />
   <AssemblyInfo>
     <AssemblyName>Banshee.Base</AssemblyName>
     <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -11,6 +11,9 @@
     <Interface>
       <InterfaceName>System.Collections.IEnumerable</InterfaceName>
     </Interface>
+    <Interface>
+      <InterfaceName>System.IDisposable</InterfaceName>
+    </Interface>
   </Interfaces>
   <Attributes>
     <Attribute>
@@ -364,6 +367,40 @@
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
+    <Member MemberName="Ejected">
+      <MemberSignature Language="C#" Value="public event EventHandler Ejected;" />
+      <MemberType>Event</MemberType>
+      <ReturnValue>
+        <ReturnType>System.EventHandler</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added.</summary>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="HalDevice">
+      <MemberSignature Language="C#" Value="public Hal.Device HalDevice;" />
+      <MemberType>Field</MemberType>
+      <ReturnValue>
+        <ReturnType>Hal.Device</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added.</summary>
+        <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>
   </Members>
   <Docs>
     <summary>To be added.</summary>
diff --git a/docs/en/Banshee.Widgets/ActiveUserEvent.xml b/docs/en/Banshee.Widgets/ActiveUserEvent.xml
index f9b7e94a6..cbc34f3cf 100644
--- a/docs/en/Banshee.Widgets/ActiveUserEvent.xml
+++ b/docs/en/Banshee.Widgets/ActiveUserEvent.xml
@@ -96,7 +96,7 @@
       </Docs>
     </Member>
     <Member MemberName="Progress">
-      <MemberSignature Language="C#" Value="public double Progress { set; };" />
+      <MemberSignature Language="C#" Value="public double Progress { set; get; };" />
       <MemberType>Property</MemberType>
       <ReturnValue>
         <ReturnType>System.Double</ReturnType>
diff --git a/docs/en/Banshee.Widgets/SearchEntry.xml b/docs/en/Banshee.Widgets/SearchEntry.xml
index 19f5c346b..f0e67f3bb 100644
--- a/docs/en/Banshee.Widgets/SearchEntry.xml
+++ b/docs/en/Banshee.Widgets/SearchEntry.xml
@@ -106,6 +106,18 @@
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
+    <Member MemberName="IsQueryAvailable">
+      <MemberSignature Language="C#" Value="public bool IsQueryAvailable { get; };" />
+      <MemberType>Property</MemberType>
+      <ReturnValue>
+        <ReturnType>System.Boolean</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added.</summary>
+        <value>To be added.</value>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
   </Members>
   <Docs>
     <summary>To be added.</summary>
diff --git a/docs/en/index.xml b/docs/en/index.xml
index 8a2973356..758cc4931 100644
--- a/docs/en/index.xml
+++ b/docs/en/index.xml
@@ -79,6 +79,12 @@
       <Type Name="AudioCdCoreDiskAddedHandler" />
       <Type Name="LogEntryType" />
       <Type Name="SpecialKey" />
+      <Type Name="IconThemeUtils" />
+      <Type Name="Gstreamer" />
+      <Type Name="ImportEventArgs" />
+      <Type Name="ImportManager" />
+      <Type Name="UriList" />
+      <Type Name="ImportEventHandler" />
     </Namespace>
     <Namespace Name="Banshee.Dap">
       <Type Name="DapProperties" />