INFRA-132 comments to end with full stops

[civicrm-core.git] / CRM / Mailing / Page / Report.php

diff --git a/CRM/Mailing/Page/Report.php b/CRM/Mailing/Page/Report.php
index eb4e82bd41da9c113060f21b3204694d38c41fcb..03adcfa276b77fc13a4bd56971c79ab8230a96e5 100644 (file)
--- a/CRM/Mailing/Page/Report.php
+++ b/CRM/Mailing/Page/Report.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -41,40 +41,61 @@ class CRM_Mailing_Page_Report extends CRM_Core_Page_Basic {
   public $_mailing_id;
 
   /**
-   * Get BAO Name
+   * Get BAO Name.
    *
-   * @return string Classname of BAO
+   * @return string
+   *   Classname of BAO
    */
-  function getBAOName() {
+  public function getBAOName() {
     return 'CRM_Mailing_BAO_Mailing';
   }
 
-  function &links() {
+  /**
+   * @return null
+   */
+  public function &links() {
     return CRM_Core_DAO::$_nullObject;
   }
 
-  function editForm() {
+  /**
+   * @return null
+   */
+  public function editForm() {
     return NULL;
   }
 
-  function editName() {
+  /**
+   * @return string
+   */
+  public function editName() {
     return 'CiviMail Report';
   }
 
   /**
    * Get user context.
    *
-   * @return string user context.
+   * @param null $mode
+   *
+   * @return string
+   *   user context.
    */
-  function userContext($mode = NULL) {
+  public function userContext($mode = NULL) {
     return 'civicrm/mailing/report';
   }
 
-  function userContextParams($mode = NULL) {
+  /**
+   * @param null $mode
+   *
+   * @return string
+   */
+  public function userContextParams($mode = NULL) {
     return 'reset=1&mid=' . $this->_mailing_id;
   }
 
-  function run() {
+  /**
+   * @return string
+   */
+  public function run() {
     $this->_mailing_id = CRM_Utils_Request::retrieve('mid', 'Positive', $this);
 
     // check that the user has permission to access mailing id
@@ -115,10 +136,10 @@ class CRM_Mailing_Page_Report extends CRM_Core_Page_Basic {
 
     $this->assign('report', $report);
     CRM_Utils_System::setTitle(ts('CiviMail Report: %1',
-        array(1 => $report['mailing']['name'])
-      ));
+      array(1 => $report['mailing']['name'])
+    ));
 
     return CRM_Core_Page::run();
   }
-}
 
+}