GNOME.org
 

[banshee] Add some hand-written API documentation

commit 8440872feea19a58c5a74a14974480d8e91f503e
Author: Gabriel Burt <gabriel burt gmail com>
Date:   Sat Mar 20 15:36:37 2010 -0700

    Add some hand-written API documentation

 docs/Hyena/en/Hyena.Collections/LruCache`2.xml     |    8 +++---
 docs/Hyena/en/Hyena.Collections/Selection.xml      |   24 ++++++++++----------
 docs/Hyena/en/Hyena.Collections/SelectionProxy.xml |    8 +++---
 docs/Hyena/en/Hyena.Metrics/HttpPoster.xml         |    4 +-
 docs/Hyena/en/Hyena.Metrics/MetricsCollection.xml  |    4 +-
 docs/Hyena/en/Hyena/CryptoUtil.xml                 |   10 ++++----
 docs/Hyena/en/Hyena/Log.xml                        |    6 ++--
 docs/Hyena/en/ns-Hyena.xml                         |    2 +-
 8 files changed, 33 insertions(+), 33 deletions(-)
---
diff --git a/docs/Hyena/en/Hyena.Collections/LruCache`2.xml b/docs/Hyena/en/Hyena.Collections/LruCache`2.xml
index 656b8f7..feaf2c8 100644
--- a/docs/Hyena/en/Hyena.Collections/LruCache`2.xml
+++ b/docs/Hyena/en/Hyena.Collections/LruCache`2.xml
@@ -20,7 +20,7 @@
   <Docs>
     <typeparam name="TKey">To be added.</typeparam>
     <typeparam name="TValue">To be added.</typeparam>
-    <summary>To be added.</summary>
+    <summary>Least Recently Used (LRU) cache, capped in size, automatically removes the least-recently used object(s) as needed.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -204,7 +204,7 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>The maximum number of items to hold in this cache.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -219,7 +219,7 @@
         <ReturnType>System.Nullable&lt;System.Double&gt;</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>The cache will try to maintain this hit-to-miss ratio by growing the cache.  If null, will not grow the cache.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -297,4 +297,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
\ No newline at end of file
diff --git a/docs/Hyena/en/Hyena.Collections/Selection.xml b/docs/Hyena/en/Hyena.Collections/Selection.xml
index 340bafd..31dc040 100644
--- a/docs/Hyena/en/Hyena.Collections/Selection.xml
+++ b/docs/Hyena/en/Hyena.Collections/Selection.xml
@@ -16,7 +16,7 @@
     </Interface>
   </Interfaces>
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Efficiently stores a set of selected ranges within some larger range.  Lookup to see if a given number in the range is selected is also efficient.  Can work fine for very small or large (eg [0, 1M]) ranges.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -41,7 +41,7 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>True if all indexes from 0 to MaxCount are selected.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -58,7 +58,7 @@
         <ReturnType>System.EventHandler</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Raised when the selection is changed.  When methods such as SelectRange are called, this event is raised just once, not once per every index selected.</summary>
         <remarks>To be added.</remarks>
       </Docs>
       <AssemblyInfo>
@@ -75,7 +75,7 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Clear the selection, and raise the Changed event.</summary>
         <remarks>To be added.</remarks>
       </Docs>
       <AssemblyInfo>
@@ -95,7 +95,7 @@
       </Parameters>
       <Docs>
         <param name="raise">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>Clear the selection, and raise the Changed event if raise is true.</summary>
         <remarks>To be added.</remarks>
       </Docs>
       <AssemblyInfo>
@@ -115,7 +115,7 @@
       </Parameters>
       <Docs>
         <param name="index">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>Returns true if the given index is selected.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>
@@ -132,7 +132,7 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>The number of items selected.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -154,7 +154,7 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>The first selected index, or -1 if none selected.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -220,7 +220,7 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>The last (highest) selected index, or -1 if none selected.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -232,7 +232,7 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>The highest possible index in this selection.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -442,7 +442,7 @@
       </Parameters>
       <Docs>
         <param name="index">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>If index is not selected, select it.  If it is selected, unselect it.</summary>
         <remarks>To be added.</remarks>
       </Docs>
       <AssemblyInfo>
@@ -508,4 +508,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
\ No newline at end of file
diff --git a/docs/Hyena/en/Hyena.Collections/SelectionProxy.xml b/docs/Hyena/en/Hyena.Collections/SelectionProxy.xml
index 50a3f64..e731be2 100644
--- a/docs/Hyena/en/Hyena.Collections/SelectionProxy.xml
+++ b/docs/Hyena/en/Hyena.Collections/SelectionProxy.xml
@@ -12,7 +12,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Convenience class allowing an observer to listen for selection Changed events, while the underlying Selection object may change at any time.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -37,7 +37,7 @@
         <ReturnType>System.EventHandler</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Raised when the underlying Selection's Changed event is raised.</summary>
         <remarks>To be added.</remarks>
       </Docs>
       <AssemblyInfo>
@@ -104,7 +104,7 @@
         <ReturnType>System.EventHandler</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Raised when the underlying Selection object is replaced with another one.</summary>
         <remarks>To be added.</remarks>
       </Docs>
       <AssemblyInfo>
@@ -114,4 +114,4 @@
       </AssemblyInfo>
     </Member>
   </Members>
-</Type>
+</Type>
\ No newline at end of file
diff --git a/docs/Hyena/en/Hyena.Metrics/HttpPoster.xml b/docs/Hyena/en/Hyena.Metrics/HttpPoster.xml
index 2786e4f..45255e8 100644
--- a/docs/Hyena/en/Hyena.Metrics/HttpPoster.xml
+++ b/docs/Hyena/en/Hyena.Metrics/HttpPoster.xml
@@ -9,7 +9,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Will send (via HTTP POST) the JSON of the pass MetricsCollection to the given URL.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -47,4 +47,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
\ No newline at end of file
diff --git a/docs/Hyena/en/Hyena.Metrics/MetricsCollection.xml b/docs/Hyena/en/Hyena.Metrics/MetricsCollection.xml
index 8463bab..b365860 100644
--- a/docs/Hyena/en/Hyena.Metrics/MetricsCollection.xml
+++ b/docs/Hyena/en/Hyena.Metrics/MetricsCollection.xml
@@ -30,7 +30,7 @@
       <Docs>
         <param name="uniqueUserId">To be added.</param>
         <param name="store">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>Constructor for a new MetricsCollection with the given unique id and the given backing store.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -205,4 +205,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
\ No newline at end of file
diff --git a/docs/Hyena/en/Hyena/CryptoUtil.xml b/docs/Hyena/en/Hyena/CryptoUtil.xml
index ab365dd..34b996a 100644
--- a/docs/Hyena/en/Hyena/CryptoUtil.xml
+++ b/docs/Hyena/en/Hyena/CryptoUtil.xml
@@ -12,7 +12,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Cryptography related utility functions.  Currently centers around MD5 hashing.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -26,8 +26,8 @@
         <Parameter Name="text" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="text">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="text">The text to test.</param>
+        <summary>Returns true if the string appears to be a MD5 hash - that is, of the correct length and allowed characters.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>
@@ -48,7 +48,7 @@
       </Parameters>
       <Docs>
         <param name="text">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>Returns the MD5 hash of the input string.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>
@@ -82,4 +82,4 @@
       </AssemblyInfo>
     </Member>
   </Members>
-</Type>
+</Type>
\ No newline at end of file
diff --git a/docs/Hyena/en/Hyena/Log.xml b/docs/Hyena/en/Hyena/Log.xml
index 4689ef2..c955763 100644
--- a/docs/Hyena/en/Hyena/Log.xml
+++ b/docs/Hyena/en/Hyena/Log.xml
@@ -12,7 +12,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Utility class for logging at various importance levels.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -137,7 +137,7 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>If false, Log.Debug* methods will not be printed.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
       </Docs>
@@ -716,4 +716,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
\ No newline at end of file
diff --git a/docs/Hyena/en/ns-Hyena.xml b/docs/Hyena/en/ns-Hyena.xml
index 18955fb..16521a7 100644
--- a/docs/Hyena/en/ns-Hyena.xml
+++ b/docs/Hyena/en/ns-Hyena.xml
@@ -3,4 +3,4 @@
     <summary>To be added.</summary>
     <remarks>To be added.</remarks>
   </Docs>
-</Namespace>
+</Namespace>
\ No newline at end of file
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]