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

phpDocumentor 2.8.5 currently doesn't support the Generic notations

Browse Source 
This will likely be implemented as soon as the proposed PSR-5: PHPDoc is accepted
This commit is contained in:
Daniel Rudolf 2015-10-27 01:48:58 +01:00
parent 92af554d14
commit a654b1585b
5 changed files with 31 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/AbstractPicoPlugin.php
View File

@ -41,7 +41,7 @@ abstract class AbstractPicoPlugin implements PicoPluginInterface
/** /**
* List of plugins which this plugin depends on * List of plugins which this plugin depends on
* *
* @var array<string> * @var string[]
* @see PicoPluginInterface::getDependencies() * @see PicoPluginInterface::getDependencies()
* @see AbstractPicoPlugin::checkDependencies() * @see AbstractPicoPlugin::checkDependencies()
*/ */
@ -50,7 +50,7 @@ abstract class AbstractPicoPlugin implements PicoPluginInterface
/** /**
* List of plugin which depend on this plugin * List of plugin which depend on this plugin
* *
* @var array<string, object> * @var object[]
* @see PicoPluginInterface::getDependants() * @see PicoPluginInterface::getDependants()
* @see AbstractPicoPlugin::checkDependants() * @see AbstractPicoPlugin::checkDependants()
*/ */

33
lib/Pico.php
View File

@ -89,7 +89,7 @@ class Pico
* List of loaded plugins * List of loaded plugins
* *
* @see Pico::loadPlugins() * @see Pico::loadPlugins()
* @var array<object>|null * @var object[]|null
*/ */
protected $plugins; protected $plugins;
@ -97,7 +97,7 @@ class Pico
* Current configuration of this Pico instance * Current configuration of this Pico instance
* *
* @see Pico::loadConfig() * @see Pico::loadConfig()
* @var array<string, mixed>|null * @var mixed[]|null
*/ */
protected $config; protected $config;
@ -129,7 +129,7 @@ class Pico
* Meta data of the page to serve * Meta data of the page to serve
* *
* @see Pico::parseFileMeta() * @see Pico::parseFileMeta()
* @var array<string, string>|null * @var string[]|null
*/ */
protected $meta; protected $meta;
@ -146,7 +146,7 @@ class Pico
* List of known pages * List of known pages
* *
* @see Pico::readPages() * @see Pico::readPages()
* @var array<array>|null * @var array[]|null
*/ */
protected $pages; protected $pages;
@ -185,7 +185,7 @@ class Pico
/** /**
* Variables passed to the twig template * Variables passed to the twig template
* *
* @var array<string, mixed>|null * @var mixed[]|null
*/ */
protected $twigVariables; protected $twigVariables;
@ -403,7 +403,7 @@ class Pico
* Returns all loaded plugins * Returns all loaded plugins
* *
* @see Pico::loadPlugins() * @see Pico::loadPlugins()
* @return array<object>|null * @return object[]|null
*/ */
public function getPlugins() public function getPlugins()
{ {
@ -463,11 +463,10 @@ class Pico
* call and Pico::run(). Options set with this method cannot be overwritten * call and Pico::run(). Options set with this method cannot be overwritten
* by {@path "config/config.php"}. * by {@path "config/config.php"}.
* *
* @param array<string, mixed> $config array with configuration variables, * @param mixed[] $config array with configuration variables, like
* like $config in {@path "config/config.php"} * $config in {@path "config/config.php"}
* @return void * @return void
* @throws RuntimeException thrown if Pico already started * @throws RuntimeException thrown if Pico already started processing
* processing
*/ */
public function setConfig(array $config) public function setConfig(array $config)
{ {
@ -635,9 +634,9 @@ class Pico
* Heads up! Calling this method triggers the `onMetaHeaders` event. * Heads up! Calling this method triggers the `onMetaHeaders` event.
* Keep this in mind to prevent a infinite loop! * Keep this in mind to prevent a infinite loop!
* *
* @return array<string, string> known meta headers; the array value * @return string[] known meta headers; the array value specifies the
* specifies the YAML key to search for, the array key is later used * YAML key to search for, the array key is later used to access the
* to access the found value * found value
*/ */
public function getMetaHeaders() public function getMetaHeaders()
{ {
@ -665,9 +664,9 @@ class Pico
* for users and pure (!) theme developers ONLY. * for users and pure (!) theme developers ONLY.
* *
* @see <http://symfony.com/doc/current/components/yaml/introduction.html> * @see <http://symfony.com/doc/current/components/yaml/introduction.html>
* @param string $rawContent the raw file contents * @param string $rawContent the raw file contents
* @param array<string, string> $headers known meta headers * @param string[] $headers known meta headers
* @return array parsed meta data * @return array parsed meta data
*/ */
public function parseFileMeta($rawContent, array $headers) public function parseFileMeta($rawContent, array $headers)
{ {
@ -1014,7 +1013,7 @@ class Pico
* URLs and paths (namely base_dir, base_url, theme_dir and theme_url) * URLs and paths (namely base_dir, base_url, theme_dir and theme_url)
* don't add a trailing slash for historic reasons. * don't add a trailing slash for historic reasons.
* *
* @return array<string, mixed> template variables * @return mixed[] template variables
*/ */
protected function getTwigVariables() protected function getTwigVariables()
{ {

4
lib/PicoPluginInterface.php
View File

@ -77,14 +77,14 @@ interface PicoPluginInterface
/** /**
* Returns a list of names of plugins required by this plugin * Returns a list of names of plugins required by this plugin
* *
* @return array<string> required plugins * @return string[] required plugins
*/ */
public function getDependencies(); public function getDependencies();
/** /**
* Returns a list of plugins which depend on this plugin * Returns a list of plugins which depend on this plugin
* *
* @return array<object> dependant plugins * @return object[] dependant plugins
*/ */
public function getDependants(); public function getDependants();

2
plugins/00-PicoDeprecated.php
View File

@ -139,7 +139,7 @@ class PicoDeprecated extends AbstractPicoPlugin
/** /**
* Read {@path "config.php"} in Picos root dir * Read {@path "config.php"} in Picos root dir
* *
* @param array<string, mixed> &$config array of config variables * @param mixed[] &$config array of config variables
* @return void * @return void
*/ */
protected function loadRootDirConfig(&$config) protected function loadRootDirConfig(&$config)

20
plugins/DummyPlugin.php
View File

@ -24,7 +24,7 @@ class DummyPlugin extends AbstractPicoPlugin
/** /**
* This plugin depends on {@link ...} * This plugin depends on {@link ...}
* *
* @var array<string> * @var string[]
* @see AbstractPicoPlugin::$dependsOn * @see AbstractPicoPlugin::$dependsOn
*/ */
protected $dependsOn = array(); protected $dependsOn = array();
@ -37,7 +37,7 @@ class DummyPlugin extends AbstractPicoPlugin
* *
* @see Pico::getPlugin() * @see Pico::getPlugin()
* @see Pico::getPlugins() * @see Pico::getPlugins()
* @param array<object> &$plugins loaded plugin instances * @param object[] &$plugins loaded plugin instances
* @return void * @return void
*/ */
public function onPluginsLoaded(&$plugins) public function onPluginsLoaded(&$plugins)
@ -49,7 +49,7 @@ class DummyPlugin extends AbstractPicoPlugin
* Triggered after Pico has read its configuration * Triggered after Pico has read its configuration
* *
* @see Pico::getConfig() * @see Pico::getConfig()
* @param array<string, mixed> &$config array of config variables * @param mixed[] &$config array of config variables
* @return void * @return void
*/ */
public function onConfigLoaded(&$config) public function onConfigLoaded(&$config)
@ -134,7 +134,7 @@ class DummyPlugin extends AbstractPicoPlugin
* Triggered when Pico reads its known meta header fields * Triggered when Pico reads its known meta header fields
* *
* @see Pico::getMetaHeaders() * @see Pico::getMetaHeaders()
* @param array<string, string> &$headers list of known meta header * @param string[] &$headers list of known meta header
* fields; the array value specifies the YAML key to search for, the * fields; the array value specifies the YAML key to search for, the
* array key is later used to access the found value * array key is later used to access the found value
* @return void * @return void
@ -148,8 +148,8 @@ class DummyPlugin extends AbstractPicoPlugin
* Triggered before Pico parses the meta header * Triggered before Pico parses the meta header
* *
* @see Pico::parseFileMeta() * @see Pico::parseFileMeta()
* @param string &$rawContent raw file contents * @param string &$rawContent raw file contents
* @param array<string, string> &$headers known meta header fields * @param string[] &$headers known meta header fields
* @return void * @return void
*/ */
public function onMetaParsing(&$rawContent, &$headers) public function onMetaParsing(&$rawContent, &$headers)
@ -161,7 +161,7 @@ class DummyPlugin extends AbstractPicoPlugin
* Triggered after Pico has parsed the meta header * Triggered after Pico has parsed the meta header
* *
* @see Pico::getFileMeta() * @see Pico::getFileMeta()
* @param array<string, string> &$meta parsed meta data * @param string[] &$meta parsed meta data
* @return void * @return void
*/ */
public function onMetaParsed(&$meta) public function onMetaParsed(&$meta)
@ -264,9 +264,9 @@ class DummyPlugin extends AbstractPicoPlugin
* Triggered before Pico renders the page * Triggered before Pico renders the page
* *
* @see Pico::getTwig() * @see Pico::getTwig()
* @param Twig_Environment &$twig twig template engine * @param Twig_Environment &$twig twig template engine
* @param array<string, mixed> &$twigVariables template variables * @param mixed[] &$twigVariables template variables
* @param string &$templateName file name of the template * @param string &$templateName file name of the template
* @return void * @return void
*/ */
public function onPageRendering(&$twig, &$twigVariables, &$templateName) public function onPageRendering(&$twig, &$twigVariables, &$templateName)