From 119a4482d83cbdadff3c5656f44f70fb959aab25 Mon Sep 17 00:00:00 2001
From: David Siegfried <david.siegfried@uni-vechta.de>
Date: Thu, 10 Mar 2022 13:56:15 +0000
Subject: [PATCH] rework php-doc changes, refs #687
---
lib/classes/URLHelper.php | 2 +-
lib/plugins/engine/PluginEngine.class.php | 4 ++--
lib/plugins/engine/PluginManager.class.php | 10 +++++-----
lib/plugins/engine/PluginRepository.class.php | 4 ++--
4 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/lib/classes/URLHelper.php b/lib/classes/URLHelper.php
index a0c27b979bf..a36cc10377f 100644
--- a/lib/classes/URLHelper.php
+++ b/lib/classes/URLHelper.php
@@ -2,7 +2,7 @@
# Lifter007: TODO
# Lifter003: TODO
# Lifter010: TODO
-/**
+/*
* URLHelper.php - utility functions for URL parameter handling
*
* Copyright (c) 2008 Elmar Ludwig
diff --git a/lib/plugins/engine/PluginEngine.class.php b/lib/plugins/engine/PluginEngine.class.php
index a0db8b86a7d..1d3e5a9b6b1 100644
--- a/lib/plugins/engine/PluginEngine.class.php
+++ b/lib/plugins/engine/PluginEngine.class.php
@@ -58,7 +58,7 @@ class PluginEngine
/**
* Get instance of the plugin specified by plugin class name.
*
- * @param class-string $class class name of plugin
+ * @param string $class class name of plugin
*/
public static function getPlugin ($class)
{
@@ -84,7 +84,7 @@ class PluginEngine
* the return values.
*
* @param string $type plugin type or null (all types)
- * @param mixed $method the method name that should be send to all plugins
+ * @param string $method the method name that should be send to all plugins
* @param mixed a variable number of arguments
*
* @return array an array containing the return values
diff --git a/lib/plugins/engine/PluginManager.class.php b/lib/plugins/engine/PluginManager.class.php
index f5c53de45da..9216754632f 100644
--- a/lib/plugins/engine/PluginManager.class.php
+++ b/lib/plugins/engine/PluginManager.class.php
@@ -115,7 +115,7 @@ class PluginManager
public function setPluginEnabled ($id, $enabled, $force = false)
{
$info = $this->getPluginInfoById($id);
- $plugin_class = '';
+ $plugin_class = null;
// Plugin is not present or no changes
if (!$info || $info['enabled'] == $enabled) {
@@ -156,7 +156,7 @@ class PluginManager
* Set the navigation position of the given plugin.
*
* @param int $id id of the plugin
- * @param string $position plugin navigation position
+ * @param int $position plugin navigation position
* @return bool indicating whether any change occured
*/
public function setPluginPosition ($id, $position)
@@ -419,7 +419,7 @@ class PluginManager
* @param string $name plugin name
* @param string $class plugin class name
* @param string $path plugin relative path
- * @param string $depends id of plugin this plugin depends on
+ * @param int $depends id of plugin this plugin depends on
*/
public function registerPlugin ($name, $class, $path, $depends = null)
{
@@ -508,7 +508,7 @@ class PluginManager
/**
* Get meta data for the plugin specified by plugin class name.
*
- * @param class-string $class class name of plugin
+ * @param string $class class name of plugin
*/
public function getPluginInfo ($class)
{
@@ -612,7 +612,7 @@ class PluginManager
/**
* Get instance of the plugin specified by plugin class name.
*
- * @param class-string $class class name of plugin
+ * @param string $class class name of plugin
* @return object
*/
public function getPlugin ($class)
diff --git a/lib/plugins/engine/PluginRepository.class.php b/lib/plugins/engine/PluginRepository.class.php
index 78b5d02edf5..bf44a8f7027 100644
--- a/lib/plugins/engine/PluginRepository.class.php
+++ b/lib/plugins/engine/PluginRepository.class.php
@@ -1,6 +1,6 @@
<?php
-/**
+/*
* PluginRepository.class.php - query plugin meta data
*
* Copyright (c) 2008 Elmar Ludwig
@@ -40,7 +40,6 @@ class PluginRepository
* Read plugin meta data from the given URL (using XML format).
* The structure of the XML is:
*
- * @param string $url given url for plugin
*
* <plugins>
* <plugin name="DummyPlugin"
@@ -52,6 +51,7 @@ class PluginRepository
* </plugin>
* [...]
* </plugins>
+ * @param string $url given url for plugin
*/
public function readMetadata($url)
{
--
GitLab