Minor: Comments improved
authorRoland Häder <roland@mxchange.org>
Thu, 29 Nov 2012 16:48:33 +0000 (16:48 +0000)
committerRoland Häder <roland@mxchange.org>
Thu, 29 Nov 2012 16:48:33 +0000 (16:48 +0000)
inc/classes/main/compressor/class_Bzip2Compressor.php
inc/classes/main/compressor/class_GzipCompressor.php
inc/classes/main/compressor/class_NullCompressor.php
inc/classes/main/compressor/class_ZlibCompressor.php

index 364838f..32991b8 100644 (file)
@@ -33,9 +33,9 @@ class Bzip2Compressor extends BaseFrameworkSystem implements Compressor {
        }
 
        /**
-        * Create a new compressor channel based a given compression handler
+        * Create a new compressor channel based a given compression handler or NULL if the required PHP functions are not found.
         *
-        * @return      $compressorInstance             An instance of this class
+        * @return      $compressorInstance             An instance of this class or NULL if the required PHP functions are not found.
         */
        public static final function createBzip2Compressor () {
                // Routines not found by default
@@ -91,7 +91,7 @@ class Bzip2Compressor extends BaseFrameworkSystem implements Compressor {
        /**
         * Getter for the file extension of this compressor
         *
-        * @return      $string         Returns always "bz2"
+        * @return      $string         Returns always 'bz2'
         */
        public final function getCompressorExtension () {
                return 'bz2';
index 2f6275b..afd0285 100644 (file)
@@ -33,9 +33,9 @@ class GzipCompressor extends BaseFrameworkSystem implements Compressor {
        }
 
        /**
-        * Create a new compressor channel based a given compression handler
+        * Create a new compressor channel based a given compression handler or NULL if the required PHP functions are not found.
         *
-        * @return      $compressorInstance             An instance of this class
+        * @return      $compressorInstance             An instance of this class or NULL if the required PHP functions are not found.
         */
        public static final function createGzipCompressor () {
                // Routines not found by default
index 4417255..cd09349 100644 (file)
@@ -82,7 +82,7 @@ class NullCompressor extends BaseFrameworkSystem implements Compressor {
        /**
         * Getter for the file extension of this compressor
         *
-        * @return      $string         Returns always "null"
+        * @return      $string         Returns always 'null'
         */
        public final function getCompressorExtension () {
                return 'null';
index 1fab637..4dfd989 100644 (file)
@@ -33,9 +33,9 @@ class ZlibCompressor extends BaseFrameworkSystem implements Compressor {
        }
 
        /**
-        * Create a new compressor channel based a given compression handler
+        * Create a new compressor channel based a given compression handler or NULL if the required PHP functions are not found.
         *
-        * @return      $compressorInstance             An instance of this class
+        * @return      $compressorInstance             An instance of this class or NULL if the required PHP functions are not found.
         */
        public static final function createZlibCompressor () {
                // Routines not found by default
@@ -88,7 +88,7 @@ class ZlibCompressor extends BaseFrameworkSystem implements Compressor {
        /**
         * Getter for the file extension of this compressor
         *
-        * @return      $string         Returns always 'gz'
+        * @return      $string         Returns always 'z'
         */
        public final function getCompressorExtension () {
                return 'z';