Merge pull request #1126 from realityking/docblocks

Fix and improve the docblocks in the legacy folder.

libraries/legacy/application/application.php

@@ -30,15 +30,6 @@ class JApplication extends JApplicationBase
 	 * @var    integer
 	 * @since  11.1
 	 */
-	protected $clientId = null;
-
-	/**
-	 * The client identifier.
-	 *
-	 * @var    integer
-	 * @since  11.1
-	 * @deprecated use $clientId or declare as private
-	 */
 	protected $_clientId = null;
 
 	/**
@@ -47,15 +38,6 @@ class JApplication extends JApplicationBase
 	 * @var    array
 	 * @since  11.1
 	 */
-	protected $messageQueue = array();
-
-	/**
-	 * The application message queue.
-	 *
-	 * @var    array
-	 * @since  11.1
-	 * @deprecated use $messageQueue or declare as private
-	 */
 	protected $_messageQueue = array();
 
 	/**
@@ -64,15 +46,6 @@ class JApplication extends JApplicationBase
 	 * @var    array
 	 * @since  11.1
 	 */
-	protected $name = null;
-
-	/**
-	 * The name of the application.
-	 *
-	 * @var    array
-	 * @since  11.1
-	 * @deprecated use $name or declare as private
-	 */
 	protected $_name = null;
 
 	/**

libraries/legacy/application/helper.php

@@ -31,7 +31,6 @@ class JApplicationHelper
 	 *
 	 * @var    array
 	 * @since  11.1
-	 * @deprecated use $clientsor declare as private
 	 */
 	protected static $_clients = null;
 
@@ -175,7 +174,7 @@ public static function addClientInfo($client)
 	 * @return  array  XML metadata.
 	 *
 	 * @since   11.1
-	 * @deprecated  12.1
+	 * @deprecated  13.3
 	 */
 	public static function parseXMLInstallFile($path)
 	{

libraries/legacy/categories/categories.php

@@ -32,15 +32,6 @@ class JCategories
 	 * @var    mixed
 	 * @since  11.1
 	 */
-	protected $nodes;
-
-	/**
-	 * Array of category nodes
-	 *
-	 * @var    mixed
-	 * @since  11.1
-	 * @deprecated use $nodes or declare as private
-	 */
 	protected $_nodes;
 
 	/**
@@ -49,15 +40,6 @@ class JCategories
 	 * @var    array
 	 * @since  11.1
 	 */
-	protected $checkedCategories;
-
-	/**
-	 * Array of checked categories -- used to save values when _nodes are null
-	 *
-	 * @var    array
-	 * @since  11.1
-	 * @deprecated use $checkedCategories or declare as private
-	 */
 	protected $_checkedCategories;
 
 	/**
@@ -66,15 +48,6 @@ class JCategories
 	 * @var    string
 	 * @since  11.1
 	 */
-	protected $extension = null;
-
-	/**
-	 * Name of the extension the categories belong to
-	 *
-	 * @var    string
-	 * @since  11.1
-	 * @deprecated use $extension or declare as private
-	 */
 	protected $_extension = null;
 
 	/**
@@ -83,15 +56,6 @@ class JCategories
 	 * @var    string
 	 * @since  11.1
 	 */
-	protected $table = null;
-
-	/**
-	 * Name of the linked content table to get category content count
-	 *
-	 * @var    string
-	 * @since  11.1
-	 * @deprecated use $table or declare as private
-	 */
 	protected $_table = null;
 
 	/**
@@ -100,15 +64,6 @@ class JCategories
 	 * @var    string
 	 * @since  11.1
 	 */
-	protected $field = null;
-
-	/**
-	 * Name of the category field
-	 *
-	 * @var    string
-	 * @since  11.1
-	 * @deprecated use $field or declare as private
-	 */
 	protected $_field = null;
 
 	/**
@@ -117,15 +72,6 @@ class JCategories
 	 * @var    string
 	 * @since  11.1
 	 */
-	protected $key = null;
-
-	/**
-	 * Name of the key field
-	 *
-	 * @var    string
-	 * @since  11.1
-	 * @deprecated use $key or declare as private
-	 */
 	protected $_key = null;
 
 	/**
@@ -134,15 +80,6 @@ class JCategories
 	 * @var    string
 	 * @since  11.1
 	 */
-	protected $statefield = null;
-
-	/**
-	 * Name of the items state field
-	 *
-	 * @var    string
-	 * @since  11.1
-	 * @deprecated use $statefield or declare as private
-	 */
 	protected $_statefield = null;
 
 	/**
@@ -151,15 +88,6 @@ class JCategories
 	 * @var    array
 	 * @since  11.1
 	 */
-	protected $options = null;
-
-	/**
-	 * Array of options
-	 *
-	 * @var    array
-	 * @since  11.1
-	 * @deprecated use $options or declare as private
-	 */
 	protected $_options = null;
 
 	/**
@@ -446,7 +374,7 @@ protected function _load($id)
  * Helper class to load Categorytree
  *
  * @package     Joomla.Platform
- * @subpackage  Application
+ * @subpackage  Categories
  * @since       11.1
  */
 class JCategoryNode extends JObject
@@ -681,28 +609,12 @@ class JCategoryNode extends JObject
 	 * @var    object
 	 * @since  11.1
 	 */
-	protected $parent = null;
-
-	/**
-	 * Parent Category object
-	 *
-	 * @var    object
-	 * @since  11.1
-	 * @deprecated use $parent or declare as private
-	 */
 	protected $_parent = null;
 
 	/**
 	 * @var Array of Children
 	 * @since  11.1
 	 */
-	protected $children = array();
-
-	/**
-	 * @var Array of Children
-	 * @since  11.1
-	 * @deprecated use $children or declare as private
-	 */
 	protected $_children = array();
 
 	/**
@@ -711,15 +623,6 @@ class JCategoryNode extends JObject
 	 * @var    array
 	 * @since  11.1
 	 */
-	protected $path = array();
-
-	/**
-	 * Path from root to this category
-	 *
-	 * @var    array
-	 * @since  11.1
-	 * @deprecated use $path or declare as private
-	 */
 	protected $_path = array();
 
 	/**
@@ -728,15 +631,6 @@ class JCategoryNode extends JObject
 	 * @var    integer
 	 * @since  11.1
 	 */
-	protected $leftSibling = null;
-
-	/**
-	 * Category left of this one
-	 *
-	 * @var    integer
-	 * @since  11.1
-	 * @deprecated use $leftSibling or declare as private
-	 */
 	protected $_leftSibling = null;
 
 	/**
@@ -745,15 +639,6 @@ class JCategoryNode extends JObject
 	 * @var
 	 * @since  11.1
 	 */
-	protected $rightSibling = null;
-
-	/**
-	 * Category right of this one
-	 *
-	 * @var
-	 * @since  11.1
-	 * @deprecated use $rightSibling or declare as private
-	 */
 	protected $_rightSibling = null;
 
 	/**
@@ -762,15 +647,6 @@ class JCategoryNode extends JObject
 	 * @var boolean
 	 * @since  11.1
 	 */
-	protected $allChildrenloaded = false;
-
-	/**
-	 * true if all children have been loaded
-	 *
-	 * @var boolean
-	 * @since  11.1
-	 * @deprecated use $allChildrenloaded or declare as private
-	 */
 	protected $_allChildrenloaded = false;
 
 	/**
@@ -779,15 +655,6 @@ class JCategoryNode extends JObject
 	 * @var
 	 * @since  11.1
 	 */
-	protected $constructor = null;
-
-	/**
-	 * Constructor of this tree
-	 *
-	 * @var
-	 * @since  11.1
-	 * @deprecated use $constructor or declare as private
-	 */
 	protected $_constructor = null;
 
 	/**

libraries/legacy/component/helper.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @package     Joomla.Platform
- * @subpackage  Application
+ * @subpackage  Component
  *
  * @copyright   Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
  * @license     GNU General Public License version 2 or later; see LICENSE
@@ -13,7 +13,7 @@
  * Component helper class
  *
  * @package     Joomla.Platform
- * @subpackage  Application
+ * @subpackage  Component
  * @since       11.1
  */
 class JComponentHelper
@@ -24,15 +24,6 @@ class JComponentHelper
 	 * @var    array
 	 * @since  11.1
 	 */
-	protected static $components = array();
-
-	/**
-	 * The component list cache
-	 *
-	 * @var    array
-	 * @since  11.1
-	 * @deprecated use $components declare as private
-	 */
 	protected static $_components = array();
 
 	/**

libraries/legacy/menu/menu.php

@@ -24,15 +24,6 @@ class JMenu extends JObject
 	 * @var    array
 	 * @since   11.1
 	 */
-	protected $items = array();
-
-	/**
-	 * Array to hold the menu items
-	 *
-	 * @var    array
-	 * @since   11.1
-	 * @deprecated use $items declare as private
-	 */
 	protected $_items = array();
 
 	/**
@@ -41,15 +32,6 @@ class JMenu extends JObject
 	 * @var    integer
 	 * @since   11.1
 	 */
-	protected $default = array();
-
-	/**
-	 * Identifier of the default menu item
-	 *
-	 * @var    integer
-	 * @since   11.1
-	 * @deprecated use $default declare as private
-	 */
 	protected $_default = array();
 
 	/**
@@ -58,15 +40,6 @@ class JMenu extends JObject
 	 * @var    integer
 	 * @since  11.1
 	 */
-	protected $active = 0;
-
-	/**
-	 * Identifier of the active menu item
-	 *
-	 * @var    integer
-	 * @since  11.1
-	 * @deprecated use $active declare as private
-	 */
 	protected $_active = 0;
 
 	/**