Fix most CS errors

Author: cweiske

Text/LanguageDetect.php

@@ -1,34 +1,31 @@
 <?php
-
 /**
- * Detects the language of a given piece of text.
- *
- * Attempts to detect the language of a sample of text by correlating ranked
- * 3-gram frequencies to a table of 3-gram frequencies of known languages.
- *
- * Implements a version of a technique originally proposed by Cavnar & Trenkle
- * (1994): "N-Gram-Based Text Categorization"
+ * Part of Text_LanguageDetect
  *
  * PHP version 5
  *
  * @category  Text
  * @package   Text_LanguageDetect
  * @author    Nicholas Pisarro <[email protected]>
  * @copyright 2005-2006 Nicholas Pisarro
- * @license   http://www.debian.org/misc/bsd.license BSD
- * @version   SVN: $Id$
+ * @license   BSD http://www.opensource.org/licenses/bsd-license.php
  * @link      http://pear.php.net/package/Text_LanguageDetect/
- * @link      http://langdetect.blogspot.com/
  */
 
 require_once 'Text/LanguageDetect/Exception.php';
 require_once 'Text/LanguageDetect/Parser.php';
 require_once 'Text/LanguageDetect/ISO639.php';
 
 /**
- * Language detection class
+ * Detects the language of a given piece of text.
+ *
+ * Attempts to detect the language of a sample of text by correlating ranked
+ * 3-gram frequencies to a table of 3-gram frequencies of known languages.
+ *
+ * Implements a version of a technique originally proposed by Cavnar & Trenkle
+ * (1994): "N-Gram-Based Text Categorization"
  *
- * Requires the langauge model database (lang.dat) that should have
+ * Requires the language model database (lang.dat) that should have
  * accompanied this class definition in order to be instantiated.
  *
  * Example usage:
@@ -60,10 +57,9 @@
  * @package   Text_LanguageDetect
  * @author    Nicholas Pisarro <[email protected]>
  * @copyright 2005 Nicholas Pisarro
- * @license   http://www.debian.org/misc/bsd.license BSD
+ * @license   BSD http://www.opensource.org/licenses/bsd-license.php
  * @version   Release: @package_version@
  * @link      http://pear.php.net/package/Text_LanguageDetect/
- * @todo      allow users to generate their own language models
  */
 class Text_LanguageDetect
 {
@@ -110,7 +106,7 @@ class Text_LanguageDetect
     var $_lang_db = array();
 
     /**
-     * stores the map of the trigram data to unicode characters
+     * Stores the map of the trigram data to unicode characters
      *
      * @access private
      * @var    array
@@ -126,9 +122,9 @@ class Text_LanguageDetect
     var $_threshold = 300;
 
     /**
-     * the maximum possible score.
+     * The maximum possible score.
      *
-     * needed for score normalization. Different depending on the
+     * Needed for score normalization. Different depending on the
      * perl compatibility setting
      *
      * @access private
@@ -155,7 +151,7 @@ class Text_LanguageDetect
     var $_use_unicode_narrowing = true;
 
     /**
-     * stores the result of the clustering operation
+     * Stores the result of the clustering operation
      *
      * @access private
      * @var    array
@@ -518,7 +514,7 @@ function _arr_rank($arr)
     /**
      * Sorts an array by value breaking ties alphabetically
      *
-     * @param array &$arr the array to sort
+     * @param array $arr the array to sort
      *
      * @return void
      * @access private
@@ -1465,7 +1461,7 @@ public function clusteredSearch($str)
     }
 
     /**
-     * ut8-safe strlen()
+     * UTF8-safe strlen()
      *
      * Returns the numbers of characters (not bytes) in a utf8 string
      *
@@ -1529,14 +1525,14 @@ function _utf8char2unicode($char)
     }
 
     /**
-     * utf8-safe fast character iterator
+     * UTF8-safe fast character iterator
      *
      * Will get the next character starting from $counter, which will then be
      * incremented. If a multi-byte char the bytes will be concatenated and
      * $counter will be incremeted by the number of bytes in the char.
      *
      * @param string $str             the string being iterated over
-     * @param int    &$counter        the iterator, will increment by reference
+     * @param int    $counter         the iterator, will increment by reference
      * @param bool   $special_convert whether to do special conversions
      *
      * @return char the next (possibly multi-byte) char from $counter

Text/LanguageDetect/Exception.php

@@ -1,4 +1,28 @@
 <?php
+/**
+ * Part of Text_LanguageDetect
+ *
+ * PHP version 5
+ *
+ * @category Text
+ * @package  Text_LanguageDetect
+ * @author   Nicholas Pisarro <[email protected]>
+ * @license  BSD http://www.opensource.org/licenses/bsd-license.php
+ * @link     http://pear.php.net/package/Text_LanguageDetect/
+ */
+
+/**
+ * Part of the PEAR language detection package
+ *
+ * PHP version 5
+ *
+ * @category Text
+ * @package  Text_LanguageDetect
+ * @author   Nicholas Pisarro <[email protected]>
+ * @license  BSD http://www.opensource.org/licenses/bsd-license.php
+ * @link     http://pear.php.net/package/Text_LanguageDetect/
+ * @link     http://langdetect.blogspot.com/
+ */
 class Text_LanguageDetect_Exception extends Exception
 {
     /**

Text/LanguageDetect/ISO639.php

@@ -9,7 +9,6 @@
  * @author    Christian Weiske <[email protected]>
  * @copyright 2011 Christian Weiske <[email protected]>
  * @license   http://www.debian.org/misc/bsd.license BSD
- * @version   SVN: $Id$
  * @link      http://pear.php.net/package/Text_LanguageDetect/
  */
 
@@ -23,7 +22,7 @@
  * @package   Text_LanguageDetect
  * @author    Christian Weiske <[email protected]>
  * @copyright 2011 Christian Weiske <[email protected]>
- * @license   http://www.debian.org/misc/bsd.license BSD
+ * @license   BSD http://www.opensource.org/licenses/bsd-license.php
  * @link      http://www.loc.gov/standards/iso639-2/php/code_list.php
  */
 class Text_LanguageDetect_ISO639

Text/LanguageDetect/Parser.php

@@ -1,16 +1,15 @@
 <?php
-
 /**
- * This class represents a text sample to be parsed.
+ * Part of Text_LanguageDetect
+ *
+ * PHP version 5
  *
  * @category  Text
  * @package   Text_LanguageDetect
- * @author    Nicholas Pisarro
- * @copyright 2006
- * @license   BSD
- * @version   CVS: $Id$
+ * @author    Nicholas Pisarro <[email protected]>
+ * @copyright 2006 Nicholas Pisarro
+ * @license   BSD http://www.opensource.org/licenses/bsd-license.php
  * @link      http://pear.php.net/package/Text_LanguageDetect/
- * @link      http://langdetect.blogspot.com/
  */
 
 /**
@@ -25,39 +24,40 @@
  *
  * @category  Text
  * @package   Text_LanguageDetect
- * @author    Nicholas Pisarro
- * @copyright 2006
- * @license   BSD
- * @version   release: @package_version@
+ * @author    Nicholas Pisarro <[email protected]>
+ * @copyright 2006 Nicholas Pisarro
+ * @license   BSD http://www.opensource.org/licenses/bsd-license.php
+ * @version   Release: @package_version@
+ * @link      http://pear.php.net/package/Text_LanguageDetect/
  */
 class Text_LanguageDetect_Parser extends Text_LanguageDetect
 {
     /**
-     * the piece of text being parsed
+     * The piece of text being parsed
      *
      * @access private
      * @var    string
      */
     var $_string;
 
     /**
-     * stores the trigram frequencies of the sample
+     * Stores the trigram frequencies of the sample
      *
      * @access private
      * @var    string
      */
     var $_trigrams = array();
 
     /**
-     * stores the trigram ranks of the sample
+     * Stores the trigram ranks of the sample
      *
      * @access private
      * @var    array
      */
     var $_trigram_ranks = array();
 
     /**
-     * stores the unicode blocks of the sample
+     * Stores the unicode blocks of the sample
      *
      * @access private
      * @var    array
@@ -99,8 +99,9 @@ class Text_LanguageDetect_Parser extends Text_LanguageDetect
     /**
      * Constructor
      *
+     * @param string $string string to be parsed
+     *
      * @access private
-     * @param  string $string string to be parsed
      */
     function __construct($string)
     {
@@ -110,8 +111,10 @@ function __construct($string)
     /**
      * PHP 4 constructor for backwards compatibility.
      *
+     * @param string $string string to be parsed
+     *
+     * @return void
      * @access private
-     * @param  string $string string to be parsed
      */
     function Text_LanguageDetect_Parser($string)
     {
@@ -121,8 +124,9 @@ function Text_LanguageDetect_Parser($string)
     /**
      * Returns true if a string is suitable for parsing
      *
-     * @param  string $str input string to test
-     * @return bool            true if acceptable, false if not
+     * @param string $str input string to test
+     *
+     * @return bool true if acceptable, false if not
      */
     public static function validateString($str)
     {
@@ -134,80 +138,81 @@ public static function validateString($str)
     }
 
     /**
-     * turn on/off trigram counting
+     * Turn on/off trigram counting
+     *
+     * @param bool $bool true for on, false for off
      *
-     * @access public
-     * @param  bool $bool true for on, false for off
+     * @return void
      */
-    function prepareTrigram($bool = true)
+    public function prepareTrigram($bool = true)
     {
         $this->_compile_trigram = $bool;
     }
 
     /**
-     * turn on/off unicode block counting
+     * Turn on/off unicode block counting
+     *
+     * @param bool $bool true for on, false for off
      *
-     * @access public
-     * @param  bool $bool true for on, false for off
+     * @return void
      */
-    function prepareUnicode($bool = true)
+    public function prepareUnicode($bool = true)
     {
         $this->_compile_unicode = $bool;
     }
 
     /**
-     * turn on/off padding the beginning of the sample string
+     * Turn on/off padding the beginning of the sample string
      *
-     * @access public
-     * @param  bool $bool true for on, false for off
+     * @param bool $bool true for on, false for off
+     *
+     * @return void
      */
-    function setPadStart($bool = true)
+    public function setPadStart($bool = true)
     {
         $this->_trigram_pad_start = $bool;
     }
 
     /**
      * Should the unicode block counter skip non-alphabetical ascii chars?
      *
-     * @access public
-     * @param  bool $bool true for on, false for off
+     * @param bool $bool true for on, false for off
+     *
+     * @return void
      */
-    function setUnicodeSkipSymbols($bool = true)
+    public function setUnicodeSkipSymbols($bool = true)
     {
         $this->_unicode_skip_symbols = $bool;
     }
 
     /**
      * Returns the trigram ranks for the text sample
      *
-     * @access public
-     * @return array    trigram ranks in the text sample
+     * @return array Trigram ranks in the text sample
      */
-    function getTrigramRanks()
+    public function getTrigramRanks()
     {
         return $this->_trigram_ranks;
     }
 
     /**
      * Return the trigram freqency table
      *
-     * only used in testing to make sure the parser is working
+     * Only used in testing to make sure the parser is working
      *
-     * @access public
-     * @return array    trigram freqencies in the text sample
+     * @return array Trigram freqencies in the text sample
      */
-    function getTrigramFreqs()
+    public function getTrigramFreqs()
     {
         return $this->_trigram;
     }
 
     /**
-     * returns the array of unicode blocks
+     * Returns the array of unicode blocks
      *
-     * @access public
-     * @return array   unicode blocks in the text sample
+     * @return array Unicode blocks in the text sample
      */
-    function getUnicodeBlocks()
+    public function getUnicodeBlocks()
     {
         return $this->_unicode_blocks;
     }
@@ -221,9 +226,9 @@ function getUnicodeBlocks()
      * Afterwards the get*() functions can be used to access the compiled
      * information.
      *
-     * @access public
+     * @return void
      */
-    function analyze()
+    public function analyze()
     {
         $len = strlen($this->_string);
         $byte_counter = 0;