From: Roland Häder <roland@mxchange.org>
Date: Thu, 29 Nov 2012 16:48:33 +0000 (+0000)
Subject: Minor: Comments improved
X-Git-Url: https://git.mxchange.org/?p=core.git;a=commitdiff_plain;h=5d0e7ed76cc491e28e0429aaa53abe93357e9d78;ds=sidebyside

Minor: Comments improved
---

diff --git a/inc/classes/main/compressor/class_Bzip2Compressor.php b/inc/classes/main/compressor/class_Bzip2Compressor.php
index 364838f0..32991b81 100644
--- a/inc/classes/main/compressor/class_Bzip2Compressor.php
+++ b/inc/classes/main/compressor/class_Bzip2Compressor.php
@@ -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';
diff --git a/inc/classes/main/compressor/class_GzipCompressor.php b/inc/classes/main/compressor/class_GzipCompressor.php
index 2f6275b8..afd0285b 100644
--- a/inc/classes/main/compressor/class_GzipCompressor.php
+++ b/inc/classes/main/compressor/class_GzipCompressor.php
@@ -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
diff --git a/inc/classes/main/compressor/class_NullCompressor.php b/inc/classes/main/compressor/class_NullCompressor.php
index 4417255a..cd093495 100644
--- a/inc/classes/main/compressor/class_NullCompressor.php
+++ b/inc/classes/main/compressor/class_NullCompressor.php
@@ -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';
diff --git a/inc/classes/main/compressor/class_ZlibCompressor.php b/inc/classes/main/compressor/class_ZlibCompressor.php
index 1fab6377..4dfd989b 100644
--- a/inc/classes/main/compressor/class_ZlibCompressor.php
+++ b/inc/classes/main/compressor/class_ZlibCompressor.php
@@ -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';