MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / languages / classes / LanguageYue.php

diff --git a/languages/classes/LanguageYue.php b/languages/classes/LanguageYue.php
index 6581d788e428cbb805c5b329632aa68e3342cc07..1107fa6df3ea72cd7c03b579aca33136e8e6a413 100644 (file)
--- a/languages/classes/LanguageYue.php
+++ b/languages/classes/LanguageYue.php
@@ -1,8 +1,36 @@
 <?php
 /**
+ * Cantonese (粵語) specific code.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Language
+ */
+
+/**
+ * Cantonese (粵語)
+ *
  * @ingroup Language
  */
 class LanguageYue extends Language {
+
+       /**
+        * @return bool
+        */
        function hasWordBreaks() {
                return false;
        }
@@ -10,23 +38,27 @@ class LanguageYue extends Language {
        /**
         * Eventually this should be a word segmentation;
         * for now just treat each character as a word.
-        * @todo Fixme: only do this for Han characters...
+        * @todo FIXME: Only do this for Han characters...
+        *
+        * @param string $string
+        * @return string
         */
-       function wordSegmentation( $string ) {
+       function segmentByWord( $string ) {
                $reg = "/([\\xc0-\\xff][\\x80-\\xbf]*)/";
                $s = self::insertSpace( $string, $reg );
                return $s;
        }
-       
-       function normalizeForSearch( $string ) {
-               wfProfileIn( __METHOD__ );
 
+       /**
+        * @param string $string
+        * @return string
+        */
+       function normalizeForSearch( $string ) {
                // Double-width roman characters
                $s = self::convertDoubleWidth( $string );
                $s = trim( $s );
                $s = parent::normalizeForSearch( $s );
 
-               wfProfileOut( __METHOD__ );
                return $s;
        }
 }