Registry introduces, comments fixed ;)

[shipsimu.git] / inc / classes / middleware / compressor / class_CompressorChannel.php

diff --git a/inc/classes/middleware/compressor/class_CompressorChannel.php b/inc/classes/middleware/compressor/class_CompressorChannel.php
index e48e091a3784c2d201cc389c83953514896dada6..73305150e08c173a90a651dc81549f1ad6a20a4c 100644 (file)
--- a/inc/classes/middleware/compressor/class_CompressorChannel.php
+++ b/inc/classes/middleware/compressor/class_CompressorChannel.php
@@ -22,10 +22,16 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class CompressorChannel extends BaseMiddleware {
-       // Output handler instance
+       /**
+        * Real compressor instance
+        */
        private $compressor = null;
 
-       // Public constructor
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
        protected function __construct () {
                // Call parent constructor!
                parent::__construct(__CLASS__);
@@ -37,7 +43,13 @@ class CompressorChannel extends BaseMiddleware {
                $this->createUniqueID();
        }
 
-       // Create a new compressor channel based a given compression handler
+       /**
+        * Create a new compressor channel based a given base directory where
+        * we shall look for compressor classes
+        *
+        * @param       $baseDir        Directory which holds our compressor classes
+        * @return      $cInstance      A prepared instance of this class
+        */
        public final static function createCompressorChannel ($baseDir) {
                // Get new instance
                $cInstance = new CompressorChannel();