SeaCMS/pico
3
0
Fork 0
Code Issues Pull Requests Activity

phpDoc class docs: Remove superflous @return void

Browse Source
This commit is contained in:
Daniel Rudolf 2019-09-11 11:29:09 +02:00
parent 56659ab95d
commit eca06a38a9
No known key found for this signature in database
GPG Key ID: A061F02CD8DE4538
4 changed files with 0 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/AbstractPicoPlugin.php
View File

@ -212,8 +212,6 @@ abstract class AbstractPicoPlugin implements PicoPluginInterface
* *
* @param bool $recursive enable required plugins automatically * @param bool $recursive enable required plugins automatically
* *
* @return void
*
* @throws RuntimeException thrown when a dependency fails * @throws RuntimeException thrown when a dependency fails
*/ */
protected function checkDependencies($recursive) protected function checkDependencies($recursive)
@ -264,8 +262,6 @@ abstract class AbstractPicoPlugin implements PicoPluginInterface
* *
* @param bool $recursive disabled dependant plugins automatically * @param bool $recursive disabled dependant plugins automatically
* *
* @return void
*
* @throws RuntimeException thrown when a dependency fails * @throws RuntimeException thrown when a dependency fails
*/ */
protected function checkDependants($recursive) protected function checkDependants($recursive)
@ -327,8 +323,6 @@ abstract class AbstractPicoPlugin implements PicoPluginInterface
* newer API versions, what requires some special (version specific) * newer API versions, what requires some special (version specific)
* precaution and is therefore usually not the case. * precaution and is therefore usually not the case.
* *
* @return void
*
* @throws RuntimeException thrown when the plugin's and Pico's API aren't * @throws RuntimeException thrown when the plugin's and Pico's API aren't
* compatible * compatible
*/ */

24
lib/Pico.php
View File

@ -508,8 +508,6 @@ class Pico
* @see Pico::getPlugin() * @see Pico::getPlugin()
* @see Pico::getPlugins() * @see Pico::getPlugins()
* *
* @return void
*
* @throws RuntimeException thrown when a plugin couldn't be loaded * @throws RuntimeException thrown when a plugin couldn't be loaded
*/ */
protected function loadPlugins() protected function loadPlugins()
@ -610,8 +608,6 @@ class Pico
* *
* @param string[] $pluginBlacklist class names of plugins not to load * @param string[] $pluginBlacklist class names of plugins not to load
* *
* @return void
*
* @throws RuntimeException thrown when a plugin couldn't be loaded * @throws RuntimeException thrown when a plugin couldn't be loaded
*/ */
protected function loadLocalPlugins(array $pluginBlacklist = array()) protected function loadLocalPlugins(array $pluginBlacklist = array())
@ -766,8 +762,6 @@ class Pico
* Marc J. Schmidt's Topological Sort / Dependency resolver in PHP * Marc J. Schmidt's Topological Sort / Dependency resolver in PHP
* @see https://github.com/marcj/topsort.php/blob/1.1.0/src/Implementations/ArraySort.php * @see https://github.com/marcj/topsort.php/blob/1.1.0/src/Implementations/ArraySort.php
* \MJS\TopSort\Implementations\ArraySort class * \MJS\TopSort\Implementations\ArraySort class
*
* @return void
*/ */
protected function sortPlugins() protected function sortPlugins()
{ {
@ -876,8 +870,6 @@ class Pico
* *
* @see Pico::setConfig() * @see Pico::setConfig()
* @see Pico::getConfig() * @see Pico::getConfig()
*
* @return void
*/ */
protected function loadConfig() protected function loadConfig()
{ {
@ -1028,8 +1020,6 @@ class Pico
* *
* @param array $config array with config variables * @param array $config array with config variables
* *
* @return void
*
* @throws LogicException thrown if Pico already started processing * @throws LogicException thrown if Pico already started processing
*/ */
public function setConfig(array $config) public function setConfig(array $config)
@ -1102,8 +1092,6 @@ class Pico
* `/pico/?someBooleanParam=` or `/pico/?index&someBooleanParam` instead. * `/pico/?someBooleanParam=` or `/pico/?index&someBooleanParam` instead.
* *
* @see Pico::getRequestUrl() * @see Pico::getRequestUrl()
*
* @return void
*/ */
protected function evaluateRequestUrl() protected function evaluateRequestUrl()
{ {
@ -1595,8 +1583,6 @@ class Pico
* @see Pico::sortPages() * @see Pico::sortPages()
* @see Pico::discoverPageSiblings() * @see Pico::discoverPageSiblings()
* @see Pico::getPages() * @see Pico::getPages()
*
* @return void
*/ */
protected function readPages() protected function readPages()
{ {
@ -1680,8 +1666,6 @@ class Pico
* *
* @see Pico::readPages() * @see Pico::readPages()
* @see Pico::getPages() * @see Pico::getPages()
*
* @return void
*/ */
protected function sortPages() protected function sortPages()
{ {
@ -1761,8 +1745,6 @@ class Pico
* *
* @see Pico::readPages() * @see Pico::readPages()
* @see Pico::getPages() * @see Pico::getPages()
*
* @return void
*/ */
protected function discoverPageSiblings() protected function discoverPageSiblings()
{ {
@ -1812,8 +1794,6 @@ class Pico
* @see Pico::getCurrentPage() * @see Pico::getCurrentPage()
* @see Pico::getPreviousPage() * @see Pico::getPreviousPage()
* @see Pico::getNextPage() * @see Pico::getNextPage()
*
* @return void
*/ */
protected function discoverCurrentPage() protected function discoverCurrentPage()
{ {
@ -1900,8 +1880,6 @@ class Pico
* non-iterable data structure with Pico 3.0. * non-iterable data structure with Pico 3.0.
* *
* @see Pico::getPageTree() * @see Pico::getPageTree()
*
* @return void
*/ */
protected function buildPageTree() protected function buildPageTree()
{ {
@ -2668,8 +2646,6 @@ class Pico
* *
* @param string $eventName name of the event to trigger * @param string $eventName name of the event to trigger
* @param array $params optional parameters to pass * @param array $params optional parameters to pass
*
* @return void
*/ */
public function triggerEvent($eventName, array $params = array()) public function triggerEvent($eventName, array $params = array())
{ {

4
lib/PicoPluginInterface.php
View File

@ -42,8 +42,6 @@ interface PicoPluginInterface
* *
* @param string $eventName name of the triggered event * @param string $eventName name of the triggered event
* @param array $params passed parameters * @param array $params passed parameters
*
* @return void
*/ */
public function handleEvent($eventName, array $params); public function handleEvent($eventName, array $params);
@ -63,8 +61,6 @@ interface PicoPluginInterface
* @param bool $auto enable or disable to fulfill a dependency. This * @param bool $auto enable or disable to fulfill a dependency. This
* parameter is optional and defaults to FALSE. * parameter is optional and defaults to FALSE.
* *
* @return void
*
* @throws RuntimeException thrown when a dependency fails * @throws RuntimeException thrown when a dependency fails
*/ */
public function setEnabled($enabled, $recursive = true, $auto = false); public function setEnabled($enabled, $recursive = true, $auto = false);

56
plugins/DummyPlugin.php
View File

@ -79,8 +79,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getPlugins() * @see Pico::getPlugins()
* *
* @param object[] $plugins loaded plugin instances * @param object[] $plugins loaded plugin instances
*
* @return void
*/ */
public function onPluginsLoaded(array $plugins) public function onPluginsLoaded(array $plugins)
{ {
@ -95,8 +93,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getPlugins() * @see Pico::getPlugins()
* *
* @param object $plugin loaded plugin instance * @param object $plugin loaded plugin instance
*
* @return void
*/ */
public function onPluginManuallyLoaded($plugin) public function onPluginManuallyLoaded($plugin)
{ {
@ -111,8 +107,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::isUrlRewritingEnabled() * @see Pico::isUrlRewritingEnabled()
* *
* @param array &$config array of config variables * @param array &$config array of config variables
*
* @return void
*/ */
public function onConfigLoaded(array &$config) public function onConfigLoaded(array &$config)
{ {
@ -125,8 +119,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getRequestUrl() * @see Pico::getRequestUrl()
* *
* @param string &$url part of the URL describing the requested contents * @param string &$url part of the URL describing the requested contents
*
* @return void
*/ */
public function onRequestUrl(&$url) public function onRequestUrl(&$url)
{ {
@ -140,8 +132,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getRequestFile() * @see Pico::getRequestFile()
* *
* @param string &$file absolute path to the content file to serve * @param string &$file absolute path to the content file to serve
*
* @return void
*/ */
public function onRequestFile(&$file) public function onRequestFile(&$file)
{ {
@ -153,8 +143,6 @@ class DummyPlugin extends AbstractPicoPlugin
* *
* @see Pico::loadFileContent() * @see Pico::loadFileContent()
* @see DummyPlugin::onContentLoaded() * @see DummyPlugin::onContentLoaded()
*
* @return void
*/ */
public function onContentLoading() public function onContentLoading()
{ {
@ -166,8 +154,6 @@ class DummyPlugin extends AbstractPicoPlugin
* *
* @see Pico::load404Content() * @see Pico::load404Content()
* @see DummyPlugin::on404ContentLoaded() * @see DummyPlugin::on404ContentLoaded()
*
* @return void
*/ */
public function on404ContentLoading() public function on404ContentLoading()
{ {
@ -182,8 +168,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::is404Content() * @see Pico::is404Content()
* *
* @param string &$rawContent raw file contents * @param string &$rawContent raw file contents
*
* @return void
*/ */
public function on404ContentLoaded(&$rawContent) public function on404ContentLoaded(&$rawContent)
{ {
@ -202,8 +186,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::is404Content() * @see Pico::is404Content()
* *
* @param string &$rawContent raw file contents * @param string &$rawContent raw file contents
*
* @return void
*/ */
public function onContentLoaded(&$rawContent) public function onContentLoaded(&$rawContent)
{ {
@ -215,8 +197,6 @@ class DummyPlugin extends AbstractPicoPlugin
* *
* @see Pico::parseFileMeta() * @see Pico::parseFileMeta()
* @see DummyPlugin::onMetaParsed() * @see DummyPlugin::onMetaParsed()
*
* @return void
*/ */
public function onMetaParsing() public function onMetaParsing()
{ {
@ -230,8 +210,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getFileMeta() * @see Pico::getFileMeta()
* *
* @param string[] &$meta parsed meta data * @param string[] &$meta parsed meta data
*
* @return void
*/ */
public function onMetaParsed(array &$meta) public function onMetaParsed(array &$meta)
{ {
@ -245,8 +223,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::substituteFileContent() * @see Pico::substituteFileContent()
* @see DummyPlugin::onContentPrepared() * @see DummyPlugin::onContentPrepared()
* @see DummyPlugin::onContentParsed() * @see DummyPlugin::onContentParsed()
*
* @return void
*/ */
public function onContentParsing() public function onContentParsing()
{ {
@ -261,8 +237,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see DummyPlugin::onContentParsed() * @see DummyPlugin::onContentParsed()
* *
* @param string &$markdown Markdown contents of the requested page * @param string &$markdown Markdown contents of the requested page
*
* @return void
*/ */
public function onContentPrepared(&$markdown) public function onContentPrepared(&$markdown)
{ {
@ -277,8 +251,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getFileContent() * @see Pico::getFileContent()
* *
* @param string &$content parsed contents (HTML) of the requested page * @param string &$content parsed contents (HTML) of the requested page
*
* @return void
*/ */
public function onContentParsed(&$content) public function onContentParsed(&$content)
{ {
@ -290,8 +262,6 @@ class DummyPlugin extends AbstractPicoPlugin
* *
* @see DummyPlugin::onPagesDiscovered() * @see DummyPlugin::onPagesDiscovered()
* @see DummyPlugin::onPagesLoaded() * @see DummyPlugin::onPagesLoaded()
*
* @return void
*/ */
public function onPagesLoading() public function onPagesLoading()
{ {
@ -313,8 +283,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @param string $id relative path to the content file * @param string $id relative path to the content file
* @param bool|null $skipPage set this to TRUE to remove this page from the * @param bool|null $skipPage set this to TRUE to remove this page from the
* pages array, otherwise leave it unchanged * pages array, otherwise leave it unchanged
*
* @return void
*/ */
public function onSinglePageLoading($id, &$skipPage) public function onSinglePageLoading($id, &$skipPage)
{ {
@ -333,8 +301,6 @@ class DummyPlugin extends AbstractPicoPlugin
* *
* @param string $id relative path to the content file * @param string $id relative path to the content file
* @param string &$rawContent raw file contents * @param string &$rawContent raw file contents
*
* @return void
*/ */
public function onSinglePageContent($id, &$rawContent) public function onSinglePageContent($id, &$rawContent)
{ {
@ -351,8 +317,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see DummyPlugin::onSinglePageContent() * @see DummyPlugin::onSinglePageContent()
* *
* @param array &$pageData data of the loaded page * @param array &$pageData data of the loaded page
*
* @return void
*/ */
public function onSinglePageLoaded(array &$pageData) public function onSinglePageLoaded(array &$pageData)
{ {
@ -371,8 +335,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see DummyPlugin::onPagesLoaded() * @see DummyPlugin::onPagesLoaded()
* *
* @param array[] &$pages list of all known pages * @param array[] &$pages list of all known pages
*
* @return void
*/ */
public function onPagesDiscovered(array &$pages) public function onPagesDiscovered(array &$pages)
{ {
@ -391,8 +353,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getPages() * @see Pico::getPages()
* *
* @param array[] &$pages sorted list of all known pages * @param array[] &$pages sorted list of all known pages
*
* @return void
*/ */
public function onPagesLoaded(array &$pages) public function onPagesLoaded(array &$pages)
{ {
@ -414,8 +374,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @param array|null &$currentPage data of the page being served * @param array|null &$currentPage data of the page being served
* @param array|null &$previousPage data of the previous page * @param array|null &$previousPage data of the previous page
* @param array|null &$nextPage data of the next page * @param array|null &$nextPage data of the next page
*
* @return void
*/ */
public function onCurrentPageDiscovered( public function onCurrentPageDiscovered(
array &$currentPage = null, array &$currentPage = null,
@ -434,8 +392,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getPageTree() * @see Pico::getPageTree()
* *
* @param array &$pageTree page tree * @param array &$pageTree page tree
*
* @return void
*/ */
public function onPageTreeBuilt(array &$pageTree) public function onPageTreeBuilt(array &$pageTree)
{ {
@ -449,8 +405,6 @@ class DummyPlugin extends AbstractPicoPlugin
* *
* @param string &$templateName file name of the template * @param string &$templateName file name of the template
* @param array &$twigVariables template variables * @param array &$twigVariables template variables
*
* @return void
*/ */
public function onPageRendering(&$templateName, array &$twigVariables) public function onPageRendering(&$templateName, array &$twigVariables)
{ {
@ -463,8 +417,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see DummyPlugin::onPageRendering() * @see DummyPlugin::onPageRendering()
* *
* @param string &$output contents which will be sent to the user * @param string &$output contents which will be sent to the user
*
* @return void
*/ */
public function onPageRendered(&$output) public function onPageRendered(&$output)
{ {
@ -479,8 +431,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @param string[] &$headers list of known meta header fields; the array * @param string[] &$headers list of known meta header fields; the array
* key specifies the YAML key to search for, the array value is later * key specifies the YAML key to search for, the array value is later
* used to access the found value * used to access the found value
*
* @return void
*/ */
public function onMetaHeaders(array &$headers) public function onMetaHeaders(array &$headers)
{ {
@ -493,8 +443,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getYamlParser() * @see Pico::getYamlParser()
* *
* @param \Symfony\Component\Yaml\Parser &$yamlParser YAML parser instance * @param \Symfony\Component\Yaml\Parser &$yamlParser YAML parser instance
*
* @return void
*/ */
public function onYamlParserRegistered(\Symfony\Component\Yaml\Parser &$yamlParser) public function onYamlParserRegistered(\Symfony\Component\Yaml\Parser &$yamlParser)
{ {
@ -507,8 +455,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getParsedown() * @see Pico::getParsedown()
* *
* @param Parsedown &$parsedown Parsedown instance * @param Parsedown &$parsedown Parsedown instance
*
* @return void
*/ */
public function onParsedownRegistered(Parsedown &$parsedown) public function onParsedownRegistered(Parsedown &$parsedown)
{ {
@ -521,8 +467,6 @@ class DummyPlugin extends AbstractPicoPlugin
* @see Pico::getTwig() * @see Pico::getTwig()
* *
* @param Twig_Environment &$twig Twig instance * @param Twig_Environment &$twig Twig instance
*
* @return void
*/ */
public function onTwigRegistered(Twig_Environment &$twig) public function onTwigRegistered(Twig_Environment &$twig)
{ {