# HG changeset patch
# User cin
# Date 2016-02-11 22:00:11
# Node ID 2dcdee4c08107b8b6b333bc537d917b3d3e0d2b7
# Parent  b933ec88446e3ae9fad132e74cee95d02286086e

docs

diff --git a/Implab/Components/ExecutionState.cs b/Implab/Components/ExecutionState.cs
--- a/Implab/Components/ExecutionState.cs
+++ b/Implab/Components/ExecutionState.cs
@@ -1,4 +1,5 @@
 namespace Implab.Components {
+    
     public enum ExecutionState {
         Uninitialized,
         Initial,
diff --git a/Implab/Components/ObjectPool.cs b/Implab/Components/ObjectPool.cs
--- a/Implab/Components/ObjectPool.cs
+++ b/Implab/Components/ObjectPool.cs
@@ -4,18 +4,17 @@ using System.Threading;
 
 namespace Implab.Components {
     /// <summary>
-    /// Базовый класс для создания пулов объектов.
+    /// The base class for creating object pools.
     /// </summary>
     /// <remarks>
-    /// <para>Пул объектов позволяет многократно использовать один и тотже объект,
-    /// что актуально для объектов, создание которых требует существенных ресурсов.
-    /// Пул объектов использует слабые ссылки, чтобы не препятствовать освобождению
-    /// ресурсов и создает новые объекты при необходимости.</para>
+    /// <para>The objects pool is offers frequently requested objects to be reused, this gives
+    /// a gool speed improvement for the 'heavy' objects. To avoid memory overhead the pool uses
+    /// weak references allowing CG to do it's work. If there are no free objects in the pool
+    /// they are created on demand. </para>
     /// <para>
-    /// Наследники должны реализовывать метод <see cref="CreateInstance()"/> для создания
-    /// новых экземпляров.
+    /// Implementors need to defined a <see cref="CreateInstance()"/> method
     /// </para>
-    /// <para>Пул поддерживает обращения сразу из нескольких потоков.</para>
+    /// <para>The instances of this class are thred-safe.</para>
     /// </remarks>
     public abstract class ObjectPool<T> where T : class {
         readonly AsyncQueue<WeakReference> m_queue = new AsyncQueue<WeakReference>();
@@ -32,11 +31,22 @@ namespace Implab.Components {
             m_size = size;
         }
 
+        /// <summary>
+        /// Creates the instance if there are no free ones in the pool.
+        /// </summary>
+        /// <returns>The new instance.</returns>
         protected abstract T CreateInstance();
 
+        /// <summary>
+        /// Cleanups the instance.
+        /// </summary>
+        /// <param name="instance">The instance to cleanup and prepare it for the next use.</param>
         protected virtual void CleanupInstance(T instance) {
         }
 
+        /// <summary>
+        /// Allocate free instance from the pool or reates a new one.
+        /// </summary>
         public T Allocate() {
             WeakReference reference;
             while (m_queue.TryDequeue(out reference)) {
@@ -49,6 +59,11 @@ namespace Implab.Components {
             return CreateInstance();
         }
 
+        /// <summary>
+        /// Release the specified instance and returns it to the pool of free instances.
+        /// </summary>
+        /// <param name="instance">The instance to return to the pool.</param>
+        /// <remarks>Before the instance is returned to the pool the <see cref="CleanupInstance(T)"/> is called.</remarks>
         public void Release(T instance) {
             if (m_count < m_size && instance != null) {
                 Interlocked.Increment(ref m_count);