Formatting doc blocks.

Standardising version and packages throughout.
cakephp · Dec 11, 2009 · e3debd0 · e3debd0
1 parent 91977a3
commit e3debd0
Show file tree

Hide file tree

Showing 38 changed files with 370 additions and 65 deletions.
diff --git a/libs/au_validation.php b/libs/au_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * AuValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class AuValidation {
 
 /**
  * Checks Postal Codes for Australia
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function postal($check) {
 		$pattern = '/^[0-9]{4}$/i';

diff --git a/libs/bd_validation.php b/libs/bd_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * BdValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class BdValidation {
 
 /**
  * Checks zipcodes for Bangladesh
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function postal($check) {
 		$pattern = '/^\d{4}$/';

diff --git a/libs/be_validation.php b/libs/be_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * BeValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class BeValidation {
 
 /**
  * Checks zipcodes for Belgium
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function postal($check) {
 		$pattern = '/^[1-9]{1}[0-9]{3}$/i';

diff --git a/libs/br_validation.php b/libs/br_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * BrValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class BrValidation {
 
 /**
  * Checks phone numbers for Brazil
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function phone($check) {
 		return (bool)preg_match('/^(\+?\d{1,3}? ?)?(\(0?\d{2}\) ?)?\d{4}[-. ]?\d{4}$/', $check);
@@ -33,8 +41,8 @@ function phone($check) {
  * Checks zipcodes (CEP) for Brazil
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function postal($check) {
 		return (bool)preg_match('/^[0-9]{5}-?[0-9]{3}$/', $check);
@@ -44,8 +52,8 @@ function postal($check) {
  * Checks cadastro de pessoa física (CPF) for Brazil
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function ssn($check) {
 		$check = str_replace(array(' ', '-', '.'), '', $check);

diff --git a/libs/ca_validation.php b/libs/ca_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * CaValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class CaValidation {
 
 /**
  * Checks zipcodes for Canada
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function postal($check) {
 		$pattern = '/\\A\\b[ABCEGHJKLMNPRSTVXY][0-9][A-Z] [0-9][A-Z][0-9]\\b\\z/i';

diff --git a/libs/cz_validation.php b/libs/cz_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * CzValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class CzValidation {
 
 /**
  * Checks zipcodes for Czech Republic
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function postal($check) {
 		$pattern = '/^[1-7]\d{2} ?\d{2}$/i';

diff --git a/libs/de_validation.php b/libs/de_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * DeValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class DeValidation {
 
 /**
  * Checks zipcodes for Germany
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function postal($check) {
 		$pattern = '/^[0-9]{5}$/i';

diff --git a/libs/dk_validation.php b/libs/dk_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * DkValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class DkValidation {
 
 /**
  * Checks social security numbers for Denmark
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function ssn($check) {
 		$pattern = '/\\A\\b[0-9]{6}-[0-9]{4}\\b\\z/i';

diff --git a/libs/es_validation.php b/libs/es_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * EsValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class EsValidation {
 
 /**
  * Checks phone numbers for Spain
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function phone($check) {
 		$pattern = '/^\\+?(34[-. ]?)?\\(?(([689]{1})(([0-9]{2})\\)?[-. ]?|([0-9]{1})\\)?[-. ]?([0-9]{1}))|70\\)?[-. ]?([0-9]{1}))([0-9]{2})[-. ]?([0-9]{1})[-. ]?([0-9]{1})[-. ]?([0-9]{2})$/';

diff --git a/libs/fr_validation.php b/libs/fr_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * FrValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class FrValidation {
 
 /**
  * Checks phone numbers for France
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function phone($check) {
 		$pattern = '/^0[1-6]{1}(([0-9]{2}){4})|((\s[0-9]{2}){4})|((-[0-9]{2}){4})$/';

diff --git a/libs/it_validation.php b/libs/it_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * ItValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class ItValidation {
 
 /**
  * Checks phone numbers for Italy
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function phone($check) {
 		$pattern = '/^([0-9]*\-?\ ?\/?[0-9]*)$/';
@@ -34,8 +42,8 @@ function phone($check) {
  * Checks zipcodes for Italy
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function postal($check) {
 		$pattern = '/^[0-9]{5}$/i';

diff --git a/libs/jp_validation.php b/libs/jp_validation.php
@@ -13,17 +13,25 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @since         localized 0.1
+ * @subpackage    localized.tests.cases.libs
+ * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * JpValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class JpValidation {
 
 /**
  * Checks zipcodes for Japan
  *
  * @param string $check The value to check.
- * @access public
  * @return boolean
+ * @access public
  */
 	function postal($check) {
 		$pattern = '/^[0-9]{3}-[0-9]{4}$/';

diff --git a/libs/mx_validation.php b/libs/mx_validation.php
@@ -13,10 +13,17 @@
  * @copyright     Copyright 2005-2009, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org
  * @package       localized
- * @subpackage    localized.libs
+ * @subpackage    localized.tests.cases.libs
  * @since         Localized Plugin v 0.1
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+/**
+ * MxValidation
+ *
+ * @package       localized
+ * @subpackage    localized.tests.cases.libs
+ */
 class MxValidation {
 
 /**