Phan: Fixing return docblocks (#40028)

Hackwar · web-flow · commit a5173837b150 · 2023-04-06T14:08:12.000+02:00
diff --git a/administrator/components/com_contact/src/Controller/ContactsController.php b/administrator/components/com_contact/src/Controller/ContactsController.php
@@ -126,7 +126,7 @@ public function getModel($name = 'Contact', $prefix = 'Administrator', $config =
     /**
      * Method to get the number of published contacts for quickicons
      *
-     * @return  string  The JSON-encoded amount of published contacts
+     * @return  void
      *
      * @since   4.3.0
      */
diff --git a/administrator/components/com_installer/src/Model/InstallerModel.php b/administrator/components/com_installer/src/Model/InstallerModel.php
@@ -142,7 +142,7 @@ protected function _getList($query, $limitstart = 0, $limit = 0)
      *
      * @param   array  $items  The array of objects
      *
-     * @return  array The array of translated objects
+     * @return  void
      */
     protected function translate(&$items)
     {
diff --git a/administrator/components/com_installer/src/View/Updatesites/HtmlView.php b/administrator/components/com_installer/src/View/Updatesites/HtmlView.php
@@ -67,7 +67,7 @@ class HtmlView extends InstallerViewDefault
      *
      * @param   string  $tpl  Template
      *
-     * @return  mixed|void
+     * @return  void
      *
      * @since   3.4
      *
diff --git a/administrator/components/com_languages/src/Controller/LanguagesController.php b/administrator/components/com_languages/src/Controller/LanguagesController.php
@@ -44,7 +44,7 @@ public function getModel($name = 'Language', $prefix = 'Administrator', $config
     /**
      * Method to get the number of published languages for quickicons
      *
-     * @return  string  The JSON-encoded amount of published languages
+     * @return  void
      *
      * @since   4.3.0
      */
diff --git a/administrator/components/com_media/src/Controller/ApiController.php b/administrator/components/com_media/src/Controller/ApiController.php
@@ -41,7 +41,7 @@ class ApiController extends BaseController
      *
      * @param   string  $task  The task to perform. If no matching task is found, the '__default' task is executed, if defined.
      *
-     * @return  mixed   The value returned by the called method.
+     * @return  void
      *
      * @since   4.0.0
      * @throws  \Exception
diff --git a/administrator/components/com_modules/src/Model/ModulesModel.php b/administrator/components/com_modules/src/Model/ModulesModel.php
@@ -223,7 +223,7 @@ protected function _getList($query, $limitstart = 0, $limit = 0)
      *
      * @param   array  &$items  The array of objects
      *
-     * @return  array The array of translated objects
+     * @return  void
      */
     protected function translate(&$items)
     {
diff --git a/administrator/components/com_newsfeeds/src/Controller/NewsfeedsController.php b/administrator/components/com_newsfeeds/src/Controller/NewsfeedsController.php
@@ -44,7 +44,7 @@ public function getModel($name = 'Newsfeed', $prefix = 'Administrator', $config
     /**
      * Method to get the number of published newsfeeds for quickicons
      *
-     * @return  string  The JSON-encoded amount of published newsfeeds
+     * @return  void
      *
      * @since   4.3.0
      */
diff --git a/administrator/components/com_newsfeeds/src/Model/NewsfeedModel.php b/administrator/components/com_newsfeeds/src/Model/NewsfeedModel.php
@@ -370,7 +370,7 @@ protected function getReorderConditions($table)
      * @param   array   $data   The data to be injected into the form
      * @param   string  $group  The plugin group to process
      *
-     * @return  array  An array of conditions to add to ordering queries.
+     * @return  void
      *
      * @since   1.6
      */
diff --git a/administrator/components/com_privacy/src/View/Export/XmlView.php b/administrator/components/com_privacy/src/View/Export/XmlView.php
@@ -33,7 +33,7 @@ class XmlView extends AbstractView
      *
      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
      *
-     * @return  mixed  A string if successful, otherwise an Error object.
+     * @return  void
      *
      * @since   3.9.0
      * @throws  \Exception
diff --git a/administrator/components/com_redirect/src/View/Link/HtmlView.php b/administrator/components/com_redirect/src/View/Link/HtmlView.php
@@ -55,7 +55,7 @@ class HtmlView extends BaseHtmlView
      *
      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
      *
-     * @return  mixed  False if unsuccessful, otherwise void.
+     * @return  void
      *
      * @since   1.6
      */
diff --git a/administrator/components/com_tags/src/View/Tags/HtmlView.php b/administrator/components/com_tags/src/View/Tags/HtmlView.php
@@ -85,7 +85,7 @@ class HtmlView extends BaseHtmlView
      *
      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
      *
-     * @return  mixed   A string if successful, otherwise an Error object.
+     * @return  void
      */
     public function display($tpl = null)
     {
diff --git a/administrator/components/com_templates/src/Model/TemplateModel.php b/administrator/components/com_templates/src/Model/TemplateModel.php
@@ -267,7 +267,7 @@ function ($a, $b) {
      * @param   string     $element   The path of the template element.
      * @param   \stdClass  $template  The stdClass object of template.
      *
-     * @return  array
+     * @return  void
      *
      * @since   4.0.0
      */
diff --git a/administrator/components/com_workflow/src/Model/WorkflowsModel.php b/administrator/components/com_workflow/src/Model/WorkflowsModel.php
@@ -146,7 +146,7 @@ public function getFilterForm($data = [], $loadData = true)
      *
      * @param   array  $items  The workflow items
      *
-     * @return  mixed  An array of data items on success, false on failure.
+     * @return  void
      *
      * @since  4.0.0
      */
diff --git a/components/com_config/src/Controller/TemplatesController.php b/components/com_config/src/Controller/TemplatesController.php
@@ -50,7 +50,7 @@ public function __construct($config = [], MVCFactoryInterface $factory = null, $
     /**
      * Method to handle cancel
      *
-     * @return  boolean  True on success.
+     * @return  void
      *
      * @since   3.2
      */
diff --git a/components/com_contact/src/View/Contact/VcfView.php b/components/com_contact/src/View/Contact/VcfView.php
@@ -37,7 +37,7 @@ class VcfView extends AbstractView
      *
      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
      *
-     * @return  string  A string if successful
+     * @return  void
      *
      * @throws  GenericDataException
      */
diff --git a/components/com_content/src/View/Featured/FeedView.php b/components/com_content/src/View/Featured/FeedView.php
@@ -35,7 +35,7 @@ class FeedView extends AbstractView
      *
      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
      *
-     * @return  mixed  A string if successful, otherwise an Error object.
+     * @return  void
      */
     public function display($tpl = null)
     {
diff --git a/components/com_tags/src/View/Tag/FeedView.php b/components/com_tags/src/View/Tag/FeedView.php
@@ -31,7 +31,7 @@ class FeedView extends BaseHtmlView
      *
      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
      *
-     * @return  mixed  A string if successful, otherwise an Error object.
+     * @return  void
      */
     public function display($tpl = null)
     {
diff --git a/components/com_tags/src/View/Tags/FeedView.php b/components/com_tags/src/View/Tags/FeedView.php
@@ -31,7 +31,7 @@ class FeedView extends BaseHtmlView
      *
      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
      *
-     * @return  mixed  A string if successful, otherwise an Error object.
+     * @return  void
      */
     public function display($tpl = null)
     {
diff --git a/components/com_tags/src/View/Tags/HtmlView.php b/components/com_tags/src/View/Tags/HtmlView.php
@@ -82,7 +82,7 @@ class HtmlView extends BaseHtmlView
      *
      * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
      *
-     * @return  mixed   A string if successful, otherwise an Error object.
+     * @return  void
      */
     public function display($tpl = null)
     {
diff --git a/components/com_users/src/View/Remind/HtmlView.php b/components/com_users/src/View/Remind/HtmlView.php
@@ -61,7 +61,7 @@ class HtmlView extends BaseHtmlView
      *
      * @param   string  $tpl  The template file to include
      *
-     * @return  mixed
+     * @return  void
      *
      * @since   1.5
      * @throws  \Exception
diff --git a/components/com_users/src/View/Reset/HtmlView.php b/components/com_users/src/View/Reset/HtmlView.php
@@ -61,7 +61,7 @@ class HtmlView extends BaseHtmlView
      *
      * @param   string  $tpl  The template file to include
      *
-     * @return  mixed
+     * @return  void
      *
      * @since   1.5
      */
diff --git a/libraries/loader.php b/libraries/loader.php
@@ -530,7 +530,7 @@ public static function loadByPsr($class)
      *
      * @param   string  $class  The fully qualified class name to autoload.
      *
-     * @return  boolean  True on success, false otherwise.
+     * @return  void
      *
      * @since   3.2
      */
diff --git a/libraries/src/Encrypt/AES/OpenSSL.php b/libraries/src/Encrypt/AES/OpenSSL.php
@@ -59,7 +59,7 @@ public function __construct()
      * @param   string  $mode      Choose between CBC (recommended) or ECB
      * @param   int     $strength  Bit strength of the key (128, 192 or 256 bits). DEPRECATED. READ NOTES ABOVE.
      *
-     * @return  mixed
+     * @return  void
      */
     public function setEncryptionMode($mode = 'cbc', $strength = 128)
     {
diff --git a/libraries/src/Filesystem/Stream.php b/libraries/src/Filesystem/Stream.php
@@ -880,7 +880,7 @@ public function get_meta_data()
      * Stream contexts
      * Builds the context from the array
      *
-     * @return  mixed
+     * @return  void
      *
      * @since   1.7.0
      * @deprecated  4.4 will be removed in 6.0
diff --git a/libraries/src/Input/Cli.php b/libraries/src/Input/Cli.php
@@ -93,7 +93,7 @@ public function serialize()
      *
      * @param   string  $input  The serialized input.
      *
-     * @return  Input  The input object.
+     * @return  void
      *
      * @since   3.0.0
      * @deprecated  5.0  Use the `joomla/console` package instead
diff --git a/libraries/src/Input/Input.php b/libraries/src/Input/Input.php
@@ -186,7 +186,7 @@ protected function getArrayRecursive(array $vars = [], $datasource = null, $defa
      *
      * @param   string  $input  The serialized input.
      *
-     * @return  Input  The input object.
+     * @return  void
      *
      * @since   3.0.0
      * @deprecated  5.0  Use Joomla\Input\Input instead

Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ public function getModel($name = 'Contact', $prefix = 'Administrator', $config =`
`126`	`126`	`/**`
`127`	`127`	`* Method to get the number of published contacts for quickicons`
`128`	`128`	`*`
`129`		`- * @return string The JSON-encoded amount of published contacts`
	`129`	`+ * @return void`
`130`	`130`	`*`
`131`	`131`	`* @since 4.3.0`
`132`	`132`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ protected function _getList($query, $limitstart = 0, $limit = 0)`
`142`	`142`	`*`
`143`	`143`	`* @param array $items The array of objects`
`144`	`144`	`*`
`145`		`- * @return array The array of translated objects`
	`145`	`+ * @return void`
`146`	`146`	`*/`
`147`	`147`	`protected function translate(&$items)`
`148`	`148`	`{`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ class HtmlView extends InstallerViewDefault`
`67`	`67`	`*`
`68`	`68`	`* @param string $tpl Template`
`69`	`69`	`*`
`70`		`- * @return mixed\|void`
	`70`	`+ * @return void`
`71`	`71`	`*`
`72`	`72`	`* @since 3.4`
`73`	`73`	`*`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function getModel($name = 'Language', $prefix = 'Administrator', $config`
`44`	`44`	`/**`
`45`	`45`	`* Method to get the number of published languages for quickicons`
`46`	`46`	`*`
`47`		`- * @return string The JSON-encoded amount of published languages`
	`47`	`+ * @return void`
`48`	`48`	`*`
`49`	`49`	`* @since 4.3.0`
`50`	`50`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ class ApiController extends BaseController`
`41`	`41`	`*`
`42`	`42`	`* @param string $task The task to perform. If no matching task is found, the '__default' task is executed, if defined.`
`43`	`43`	`*`
`44`		`- * @return mixed The value returned by the called method.`
	`44`	`+ * @return void`
`45`	`45`	`*`
`46`	`46`	`* @since 4.0.0`
`47`	`47`	`* @throws \Exception`
Original file line number	Diff line number	Diff line change
`@@ -223,7 +223,7 @@ protected function _getList($query, $limitstart = 0, $limit = 0)`
`223`	`223`	`*`
`224`	`224`	`* @param array &$items The array of objects`
`225`	`225`	`*`
`226`		`- * @return array The array of translated objects`
	`226`	`+ * @return void`
`227`	`227`	`*/`
`228`	`228`	`protected function translate(&$items)`
`229`	`229`	`{`
Original file line number	Diff line number	Diff line change
`@@ -370,7 +370,7 @@ protected function getReorderConditions($table)`
`370`	`370`	`* @param array $data The data to be injected into the form`
`371`	`371`	`* @param string $group The plugin group to process`
`372`	`372`	`*`
`373`		`- * @return array An array of conditions to add to ordering queries.`
	`373`	`+ * @return void`
`374`	`374`	`*`
`375`	`375`	`* @since 1.6`
`376`	`376`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ class XmlView extends AbstractView`
`33`	`33`	`*`
`34`	`34`	`* @param string $tpl The name of the template file to parse; automatically searches through the template paths.`
`35`	`35`	`*`
`36`		`- * @return mixed A string if successful, otherwise an Error object.`
	`36`	`+ * @return void`
`37`	`37`	`*`
`38`	`38`	`* @since 3.9.0`
`39`	`39`	`* @throws \Exception`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ class HtmlView extends BaseHtmlView`
`55`	`55`	`*`
`56`	`56`	`* @param string $tpl The name of the template file to parse; automatically searches through the template paths.`
`57`	`57`	`*`
`58`		`- * @return mixed False if unsuccessful, otherwise void.`
	`58`	`+ * @return void`
`59`	`59`	`*`
`60`	`60`	`* @since 1.6`
`61`	`61`	`*/`