Several small optimizations; improved XML comments; added a text file for storing general ideas about the design of Nuclex.Support

git-svn-id: file:///srv/devel/repo-conversion/nusu@15 d2e56fa2-650e-0410-a79f-9358c0239efd

Source/Collections/RingMemoryStream.cs

@@ -4,6 +4,10 @@ using System.IO;
 namespace Nuclex.Support.Collections {
 
   /// <summary>Specialized memory stream for ring buffers</summary>
+  /// <remarks>
+  ///   This ring buffer class is specialized for binary data and tries to achieve
+  ///   optimal efficiency for storing and retrieving chunks of multiple bytes at once.
+  /// </remarks>
   public class RingMemoryStream : Stream {
 
     /// <summary>Initializes a new ring memory stream</summary>
@@ -16,7 +20,8 @@ namespace Nuclex.Support.Collections {
 
     /// <summary>Maximum amount of data that will fit into the ring memory stream</summary>
     /// <exception cref="ArgumentOutOfRangeException">
-    ///   If the reduced capacity is too small for the ring buffer's current data
+    ///   Thrown if the new capacity is too small for the data already contained
+    ///   in the ring buffer.
     /// </exception>
     public long Capacity {
       get { return this.ringBuffer.Length; }

Source/Collections/TransformingReadOnlyCollection.cs

@@ -253,7 +253,7 @@ namespace Nuclex.Support.Collections {
     ///   This method is used to transform an item in the wrapped collection into
     ///   the exposed item type whenever the user accesses an item. Expect it to
     ///   be called frequently, because the TransformingReadOnlyCollection does
-    ///   not cache otherwise store the transformed items.
+    ///   not cache or otherwise store the transformed items.
     /// </remarks>
     protected abstract ExposedItemType Transform(ContainedItemType item);