Cleanup phpdoc comments

[civicrm-core.git] / CRM / Utils / Signer.php

diff --git a/CRM/Utils/Signer.php b/CRM/Utils/Signer.php
index 9e8d5ab460a7e7068da360255cd7c8b2ae62ef3d..05987a6b0b4cce254642203932541edaaa3b6803 100644 (file)
--- a/CRM/Utils/Signer.php
+++ b/CRM/Utils/Signer.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -107,6 +107,8 @@ class CRM_Utils_Signer {
    *
    * @param $token string, the full public token representing the signature
    * @param $params array, key-value pairs
+   *
+   * @throws Exception
    * @return bool, TRUE iff all $paramNames for the submitted validate($params) and the original sign($params)
    */
   function validate($token, $params) {
@@ -118,6 +120,9 @@ class CRM_Utils_Signer {
     return ($token == $newToken);
   }
 
+  /**
+   * @return string
+   */
   function createSalt() {
     // It would be more secure to generate a new value but liable to run this
     // many times on certain admin pages; so instead we'll re-use the hash.