From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Tue, 27 Jan 2015 00:21:28 +0000 (+1300)
Subject: comment fixes
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=eca2872882c7f4307e77df3e5386a420a27852d1;p=civicrm-core.git

comment fixes
---

diff --git a/CRM/Core/Payment/Dummy.php b/CRM/Core/Payment/Dummy.php
index 90fb06e534..bb0d697341 100644
--- a/CRM/Core/Payment/Dummy.php
+++ b/CRM/Core/Payment/Dummy.php
@@ -26,7 +26,10 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment {
   protected $_doDirectPaymentResult = array();
 
   /**
+   * Set result from do Direct Payment for test purposes.
+   *
    * @param array $doDirectPaymentResult
+   *  Result to be returned from test.
    */
   public function setDoDirectPaymentResult($doDirectPaymentResult) {
     $this->_doDirectPaymentResult = $doDirectPaymentResult;
@@ -115,10 +118,15 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment {
   }
 
   /**
-   * @param null $errorCode
-   * @param null $errorMessage
+   * Generate error object.
+   *
+   * Throwing exceptions is preferred over this.
+   *
+   * @param string $errorCode
+   * @param string $errorMessage
    *
-   * @return object
+   * @return CRM_Core_Error
+   *   Error object.
    */
   public function &error($errorCode = NULL, $errorMessage = NULL) {
     $e = CRM_Core_Error::singleton();