Commits

Anonymous committed 6833feb Draft

documentation fixes/cleanup

Comments (0)

Files changed (4)

Cineraria.Concurrency/Channel.cs

         /// <summary>
         /// Object used for lock() blocks.
         /// </summary>
-        /// <remarks>See http://stackoverflow.com/questions/251391/why-is-lockthis-bad </remarks>
+        /// <remarks>
+        /// See http://stackoverflow.com/questions/251391/why-is-lockthis-bad
+        /// </remarks>
         private readonly object _syncRoot = new object();
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="Channel&lt;T&gt;"/> class.
+        /// Initializes a new instance of the <see cref="Channel&lt;T&gt;"/>
+        /// class.
         /// </summary>
         public Channel()
         {
         }
 
         /// <summary>
-        /// Attempts to put the specified item into the channel, waiting a maximum of
-        /// <paramref name="milliseconds"/> before giving up.
+        /// Attempts to put the specified item into the channel, waiting a
+        /// maximum of <paramref name="milliseconds"/> before giving up.
         /// </summary>
         /// <param name="item">The item to put.</param>
         /// <param name="milliseconds">

Cineraria.Convenience/EnumerableExtensions.cs

-namespace Cineraria.Convenience
+// -----------------------------------------------------------------------
+// <copyright file="EnumerableExtensions.cs">
+//     Copyright (c) Rhys 2012-05-29. All rights reserved.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Cineraria.Convenience
 {
     using System.Collections.Generic;
     using System.Linq;
     /// <summary>
     /// An element from an enumerable with an index.
     /// </summary>
-    /// <typeparam name="T"></typeparam>
+    /// <typeparam name="T">The type of element contained.</typeparam>
     public struct ElementIndex<T>
     {
         /// <summary>
         /// </summary>
         /// <typeparam name="T">Collection type.</typeparam>
         /// <param name="enumerable">The enumerable.</param>
-        /// <returns></returns>
-        public static IEnumerable<ElementIndex<T>> WithIndex<T>(this IEnumerable<T> enumerable)
+        /// <returns>
+        /// An enumerable containing each element and a 0-based index.
+        /// </returns>
+        public static IEnumerable<ElementIndex<T>> WithIndex<T>(
+            this IEnumerable<T> enumerable)
         {
             return enumerable.Select((e, i) => new ElementIndex<T> { Element = e, Index = i });
         }

Cineraria.Net.Serve/GlobalSuppressions.cs

-// This file is used by Code Analysis to maintain SuppressMessage
+// <auto-generated />
+// This file is used by Code Analysis to maintain SuppressMessage
 // attributes that are applied to this project.
 // Project-level suppressions either have no target or are given
 // a specific target and scoped to a namespace, type, member, etc.

Cineraria.Net.Serve/RemoteClient.cs

 // -----------------------------------------------------------------------
-// <copyright file="Connection.cs">
+// <copyright file="RemoteClient.cs">
 //     Copyright (c) Rhys 2012-05-23. All rights reserved.
 // </copyright>
 // -----------------------------------------------------------------------