Consistent phpdoc entries

2013-03-20 09:35:19 +11:00
parent 2cdd130d1a
commit f2816dd902
207 changed files with 570 additions and 743 deletions
--- a/modules/invoice/classes/Controller/Admin/Invoice.php
+++ b/modules/invoice/classes/Controller/Admin/Invoice.php
@@ -3,11 +3,10 @@
 /**
 * This class provides invoice capabilities.
 *
- * @package    OSB
- * @subpackage Invoice
+ * @package    Invoice
 * @category   Controllers/Admin
 * @author     Deon George
- * @copyright  (c) 2010 Open Source Billing
+ * @copyright  (c) 2009-2013 Open Source Billing
 * @license    http://dev.osbill.net/license.html
 *
 * Column Definitions:
--- a/modules/invoice/classes/Controller/Invoice.php
+++ b/modules/invoice/classes/Controller/Invoice.php
@@ -3,11 +3,10 @@
 /**
 * This class provides invoice capabilities.
 *
- * @package    OSB
- * @subpackage Invoice
+ * @package    Invoice
 * @category   Controllers
 * @author     Deon George
- * @copyright  (c) 2010 Open Source Billing
+ * @copyright  (c) 2009-2013 Open Source Billing
 * @license    http://dev.osbill.net/license.html
 */
 class Controller_Invoice extends Controller_TemplateDefault {
--- a/modules/invoice/classes/Controller/Task/Invoice.php
+++ b/modules/invoice/classes/Controller/Task/Invoice.php
@@ -3,11 +3,10 @@
 /**
 * This class provides OSB invoice task capabilities.
 *
- * @package    OSB
- * @subpackage Invoice
- * @category   Controllers/Task
+ * @package    Invoice
+ * @category   Controllers
 * @author     Deon George
- * @copyright  (c) 2010 Open Source Billing
+ * @copyright  (c) 2009-2013 Open Source Billing
 * @license    http://dev.osbill.net/license.html
 */
 class Controller_Task_Invoice extends Controller_Task {
--- a/modules/invoice/classes/Controller/User/Invoice.php
+++ b/modules/invoice/classes/Controller/User/Invoice.php
@@ -3,12 +3,11 @@
 /**
 * This class provides User Invoice functions
 *
- * @package    OSB
- * @subpackage Invoice
+ * @package    Invoice
 * @category   Controllers/User
 * @author     Deon George
- * @copyright  (c) 2010 Deon George
- * @license    http://dev.leenooks.net/license.html
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
 */
 class Controller_User_Invoice extends Controller_TemplateDefault_User {
 	protected $secure_actions = array(
--- a/modules/invoice/classes/Invoice.php
+++ b/modules/invoice/classes/Invoice.php
@@ -3,12 +3,11 @@
 /**
 * This class provides invoice information
 *
- * @package    OSB
- * @subpackage Invoice
+ * @package    Invoice
 * @category   Helpers
 * @author     Deon George
- * @copyright  (c) 2010 Deon George
- * @license    http://dev.leenooks.net/license.html
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
 */
 class Invoice {
 	// This invoice Object
--- a/modules/invoice/classes/Invoice/TCPDF.php
+++ b/modules/invoice/classes/Invoice/TCPDF.php
@@ -3,22 +3,16 @@
 /**
 * This class provides invoice PDF rendering capability
 *
- * @package    OSB
- * @subpackage Invoice
+ * @package    Invoice
 * @category   Helpers
 * @author     Deon George
- * @copyright  (c) 2010 Deon George
- * @license    http://dev.leenooks.net/license.html
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
 */

 define('FPDF_FONTPATH','includes/tcpdf/fonts/');
 require_once('includes/tcpdf/tcpdf.php');

-/**
- * PDF Invoice Base
- *
- * @subpackage Module:Invoice
- */
 abstract class Invoice_TCPDF extends TCPDF {
 	// Our invoice object
 	protected $io;
--- a/modules/invoice/classes/Invoice/TCPDF/Default.php
+++ b/modules/invoice/classes/Invoice/TCPDF/Default.php
@@ -3,12 +3,11 @@
 /**
 * This class provides invoice rending use TCPDF
 *
- * @package    OSB
- * @subpackage Invoice
+ * @package    Invoice
 * @category   Helpers
 * @author     Deon George
- * @copyright  (c) 2010 Deon George
- * @license    http://dev.leenooks.net/license.html
+ * @copyright  (c) 2009-2013 Open Source Billing
+ * @license    http://dev.osbill.net/license.html
 */
 class Invoice_TCPDF_Default extends Invoice_TCPDF {
 	// Current line being printed
--- a/modules/invoice/classes/Model/Invoice.php
+++ b/modules/invoice/classes/Model/Invoice.php
@@ -3,11 +3,10 @@
 /**
 * This class provides invoice capabilities.
 *
- * @package    OSB
- * @subpackage Invoice
+ * @package    Invoice
 * @category   Models
 * @author     Deon George
- * @copyright  (c) 2010 Open Source Billing
+ * @copyright  (c) 2009-2013 Open Source Billing
 * @license    http://dev.osbill.net/license.html
 */
 class Model_Invoice extends ORM_OSB implements Cartable {
--- a/modules/invoice/classes/Model/Invoice/Item.php
+++ b/modules/invoice/classes/Model/Invoice/Item.php
@@ -3,11 +3,10 @@
 /**
 * This class provides invoice item capabilities.
 *
- * @package    OSB
- * @subpackage Invoice
+ * @package    Invoice
 * @category   Models
 * @author     Deon George
- * @copyright  (c) 2010 Open Source Billing
+ * @copyright  (c) 2009-2013 Open Source Billing
 * @license    http://dev.osbill.net/license.html
 */
 class Model_Invoice_Item extends ORM_OSB {
--- a/modules/invoice/classes/Task/Invoice/Complete.php
+++ b/modules/invoice/classes/Task/Invoice/Complete.php
@@ -3,11 +3,10 @@
 /**
 * Mark all invoices that have been paid as complete, so that they are not processed again.
 *
- * @package    OSB
- * @subpackage Invoice
- * @category   Task/Invoice
+ * @package    Invoice
+ * @category   Tasks
 * @author     Deon George
- * @copyright  (c) 2010 Open Source Billing
+ * @copyright  (c) 2009-2013 Open Source Billing
 * @license    http://dev.osbill.net/license.html
 */
 class Task_Invoice_Complete extends Task {