[CS] long form function return types; round 2

components/com_config/controller/modules/display.php

@@ -21,7 +21,7 @@ class ConfigControllerModulesDisplay extends ConfigControllerDisplay
 	/**
 	 * Method to display module editing.
 	 *
-	 * @return  bool	True on success, false on failure.
+	 * @return  boolean  True on success, false on failure.
 	 *
 	 * @since   3.2
 	 */

components/com_config/controller/modules/save.php

@@ -21,7 +21,7 @@ class ConfigControllerModulesSave extends JControllerBase
 	/**
 	 * Method to save module editing.
 	 *
-	 * @return  bool	True on success.
+	 * @return  boolean  True on success.
 	 *
 	 * @since   3.2
 	 */

components/com_search/models/search.php

@@ -19,35 +19,35 @@ class SearchModelSearch extends JModelLegacy
 	/**
 	 * Search data array
 	 *
-	 * @var array
+	 * @var   array
 	 */
 	protected $_data = null;
 
 	/**
 	 * Search total
 	 *
-	 * @var integer
+	 * @var   integer
 	 */
 	protected $_total = null;
 
 	/**
 	 * Search areas
 	 *
-	 * @var integer
+	 * @var   integer
 	 */
-	protected  $_areas = null;
+	protected $_areas = null;
 
 	/**
 	 * Pagination object
 	 *
-	 * @var object
+	 * @var   object
 	 */
 	protected $_pagination = null;
 
 	/**
 	 * Constructor
 	 *
-	 * @since 1.5
+	 * @since  1.5
 	 */
 	public function __construct()
 	{
@@ -97,7 +97,7 @@ public function __construct()
 	 *
 	 * @return  void
 	 *
-	 * @access	public
+	 * @access  public
 	 */
 	public function setSearch($keyword, $match = 'all', $ordering = 'newest')
 	{
@@ -127,8 +127,8 @@ public function setSearch($keyword, $match = 'all', $ordering = 'newest')
 	/**
 	 * Method to get weblink item data for the category
 	 *
-	 * @access public
-	 * @return array
+	 * @access  public
+	 * @return  array
 	 */
 	public function getData()
 	{
@@ -199,7 +199,7 @@ public function setAreas($active = array(), $search = array())
 	/**
 	 * Method to get a pagination object of the weblink items for the category
 	 *
-	 * @access public
+	 * @access  public
 	 * @return  integer
 	 */
 	public function getPagination()
@@ -216,9 +216,9 @@ public function getPagination()
 	/**
 	 * Method to get the search areas
 	 *
-	 * @return int
+	 * @return  integer
 	 *
-	 * @since 1.5
+	 * @since   1.5
 	 */
 	public function getAreas()
 	{

components/com_tags/views/tag/view.html.php

@@ -18,18 +18,53 @@
  */
 class TagsViewTag extends JViewLegacy
 {
+	/**
+	 * The model state
+	 *
+	 * @var   \Joomla\Registry\Registry
+	 */
 	protected $state;
 
+	/**
+	 * An array of items.
+	 *
+	 * @var   array
+	 */
 	protected $items;
 
+	/**
+	 * The active JObject (on success, false on failure)
+	 *
+	 * @var   JObject|boolean
+	 */
 	protected $item;
 
+	/**
+	 * Array of Children objects
+	 *
+	 * @var  array
+	 */
 	protected $children;
 
+	/**
+	 * The pagination object.
+	 *
+	 * @var   JPagination
+	 */
 	protected $pagination;
 
+	/**
+	 * The application parameters
+	 *
+	 * @var  \Joomla\Registry\Registry  The parameters object
+	 */
 	protected $params;
 
+	/**
+	 * Array of tags title
+	 *
+	 * @var  array
+	 */
 	protected $tags_title;
 
 	/**
@@ -204,7 +239,7 @@ public function display($tpl = null)
 	/**
 	 * Prepares the document.
 	 *
-	 * @return void
+	 * @return  void
 	 */
 	protected function _prepareDocument()
 	{
@@ -292,7 +327,7 @@ protected function _prepareDocument()
 	/**
 	 * Creates the tags title for the output
 	 *
-	 * @return bool
+	 * @return  boolean
 	 */
 	protected function getTagsTitle()
 	{

installation/model/languages.php

@@ -227,7 +227,7 @@ protected function getLanguageManifest($uid)
 	 *
 	 * @param   string  $remote_manifest  URL to the manifest XML file of the remote package.
 	 *
-	 * @return  string|bool
+	 * @return  string|boolean
 	 *
 	 * @since   3.1
 	 */
@@ -244,7 +244,7 @@ protected function getPackageUrl($remote_manifest)
 	 *
 	 * @param   string  $url  URL of the package.
 	 *
-	 * @return  array|bool Package details or false on failure.
+	 * @return  array|boolean Package details or false on failure.
 	 *
 	 * @since   3.1
 	 */
@@ -1418,7 +1418,7 @@ public function addAssociations($groupedAssociations)
 	/**
 	 * Retrieve the admin user id.
 	 *
-	 * @return  int|bool One Administrator ID.
+	 * @return  integer|boolean One Administrator ID.
 	 *
 	 * @since   3.2
 	 */

libraries/src/Access/Access.php

@@ -327,7 +327,7 @@ protected static function &preloadPermissionsParentIdMapping($assetType)
 	 *                               (e.g. 'com_content.article', 'com_menus.menu.2', 'com_contact').
 	 * @param   boolean  $reload     Reload the preloaded assets.
 	 *
-	 * @return  bool  True
+	 * @return  boolean  True
 	 *
 	 * @since   1.6
 	 * @note    This function will return void in 4.0.

libraries/src/Application/WebApplication.php

@@ -633,7 +633,7 @@ public function redirect($url, $status = 303)
 	 *
 	 * @param   integer  $state  The HTTP 1.1 status code.
 	 *
-	 * @return  bool
+	 * @return  boolean
 	 *
 	 * @since  3.8.0
 	 */

libraries/src/Http/Transport/StreamTransport.php

@@ -274,7 +274,7 @@ protected function getResponse(array $headers, $body)
 	/**
 	 * Method to check if http transport stream available for use
 	 *
-	 * @return bool true if available else false
+	 * @return  boolean  true if available else false
 	 *
 	 * @since   12.1
 	 */

libraries/src/Installer/Adapter/ComponentAdapter.php

@@ -1312,7 +1312,7 @@ public function refreshManifestCache()
 	 * @param   array    &$data     The menu item data to create
 	 * @param   integer  $parentId  The parent menu item ID
 	 *
-	 * @return  bool|int  Menu item ID on success, false on failure
+	 * @return  boolean|integer  Menu item ID on success, false on failure
 	 */
 	protected function _createAdminMenuItem(array &$data, $parentId)
 	{

libraries/src/Menu/Node.php

@@ -136,7 +136,7 @@ public function removeChild(Node $child)
 	/**
 	 * Test if this node has a parent
 	 *
-	 * @return  bool  True if there is a parent
+	 * @return  boolean  True if there is a parent
 	 *
 	 * @since   3.8.0
 	 */
@@ -160,7 +160,7 @@ public function getParent()
 	/**
 	 * Test if this node has children
 	 *
-	 * @return  bool
+	 * @return  boolean
 	 *
 	 * @since   3.8.0
 	 */
@@ -184,7 +184,7 @@ public function getChildren()
 	/**
 	 * Find the current node depth in the tree hierarchy
 	 *
-	 * @return  int  The node level in the hierarchy, where ROOT == 0, First level menu item == 1, and so on.
+	 * @return  integer  The node level in the hierarchy, where ROOT == 0, First level menu item == 1, and so on.
 	 *
 	 * @since   3.8.0
 	 */
@@ -196,7 +196,7 @@ public function getLevel()
 	/**
 	 * Check whether the object instance node is the root node
 	 *
-	 * @return  bool
+	 * @return  boolean
 	 *
 	 * @since   3.8.0
 	 */

libraries/src/Updater/UpdateAdapter.php

@@ -207,7 +207,7 @@ protected function getUpdateSiteName($updateSiteId)
 	 *
 	 * @param   array  $options  The update options, see findUpdate() in children classes
 	 *
-	 * @return  bool|\JHttpResponse  False if we can't connect to the site, JHttpResponse otherwise
+	 * @return  boolean|\JHttpResponse  False if we can't connect to the site, JHttpResponse otherwise
 	 *
 	 * @throws  \Exception
 	 */

libraries/src/Utility/BufferStreamHandler.php

@@ -200,7 +200,7 @@ public function stream_seek($offset, $whence)
 	 *
 	 * @param   integer  $offset  The offset in bytes
 	 *
-	 * @return bool
+	 * @return  boolean
 	 */
 	protected function seek_set($offset)
 	{
@@ -219,7 +219,7 @@ protected function seek_set($offset)
 	 *
 	 * @param   integer  $offset  The offset in bytes
 	 *
-	 * @return bool
+	 * @return  boolean
 	 */
 	protected function seek_cur($offset)
 	{
@@ -238,7 +238,7 @@ protected function seek_cur($offset)
 	 *
 	 * @param   integer  $offset  The offset in bytes
 	 *
-	 * @return bool
+	 * @return  boolean
 	 */
 	protected function seek_end($offset)
 	{

libraries/src/Utility/Utility.php

@@ -52,7 +52,7 @@ public static function parseAttributes($string)
 	 *
 	 * @param   mixed  $custom  A custom upper limit, if the PHP settings are all above this then this will be used
 	 *
-	 * @return  int  Size in number of bytes
+	 * @return  integer  Size in number of bytes
 	 *
 	 * @since   3.7.0
 	 */

plugins/user/joomla/joomla.php

@@ -276,7 +276,7 @@ public function onUserLogin($user, $options = array())
 	 * @param   array  $user     Holds the user data.
 	 * @param   array  $options  Array holding options (client, ...).
 	 *
-	 * @return  bool  True on success
+	 * @return  boolean  True on success
 	 *
 	 * @since   1.5
 	 */

plugins/user/profile/profile.php

@@ -135,7 +135,7 @@ public function onContentPrepareData($context, $data)
 	 *
 	 * @param   string  $value  URL to use
 	 *
-	 * @return mixed|string
+	 * @return  mixed|string
 	 */
 	public static function url($value)
 	{
@@ -200,7 +200,7 @@ public static function dob($value)
 	 *
 	 * @param   boolean  $value  input value
 	 *
-	 * @return string
+	 * @return  string
 	 */
 	public static function tos($value)
 	{
@@ -357,10 +357,10 @@ public function onContentPrepareForm($form, $data)
 	 * @param   boolean  $isnew  True if a new user is stored.
 	 * @param   array    $data   Holds the new user data.
 	 *
-	 * @return    boolean
+	 * @return  boolean
 	 *
 	 * @since   3.1
-	 * @throws    InvalidArgumentException on invalid date.
+	 * @throws  InvalidArgumentException on invalid date.
 	 */
 	public function onUserBeforeSave($user, $isnew, $data)
 	{
@@ -408,7 +408,7 @@ public function onUserBeforeSave($user, $isnew, $data)
 	 * @param   boolean  $result  true if saving the user worked
 	 * @param   string   $error   error message
 	 *
-	 * @return bool
+	 * @return  boolean
 	 */
 	public function onUserAfterSave($data, $isNew, $result, $error)
 	{