beenull/Pico
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Improve/update/fix phpDoc class docs

Browse source
This commit is contained in:
Daniel Rudolf 2018-12-03 11:52:05 +01:00
parent 5e4d758acb
commit cde8c8697b
No known key found for this signature in database
GPG key ID: A061F02CD8DE4538
2 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/AbstractPicoPlugin.php
View file

@ -72,7 +72,7 @@ abstract class AbstractPicoPlugin implements PicoPluginInterface
* *
* @see AbstractPicoPlugin::checkDependants() * @see AbstractPicoPlugin::checkDependants()
* @see PicoPluginInterface::getDependants() * @see PicoPluginInterface::getDependants()
* @var object[] * @var object[]|null
*/ */
private $dependants; private $dependants;

16
lib/Pico.php
View file

@ -228,7 +228,7 @@ class Pico
* Parsedown Extra instance used for markdown parsing * Parsedown Extra instance used for markdown parsing
* *
* @see Pico::getParsedown() * @see Pico::getParsedown()
* @var ParsedownExtra|null * @var Parsedown|null
*/ */
protected $parsedown; protected $parsedown;
@ -1322,10 +1322,10 @@ class Pico
* *
* Meta data MUST start on the first line of the file, either opened and * Meta data MUST start on the first line of the file, either opened and
* closed by `---` or C-style block comments (deprecated). The headers are * closed by `---` or C-style block comments (deprecated). The headers are
* parsed by the YAML component of the Symfony project, keys are lowered. * parsed by the YAML component of the Symfony project. If you're a plugin
* If you're a plugin developer, you MUST register new headers during the * developer, you MUST register new headers during the `onMetaHeaders`
* `onMetaHeaders` event first. The implicit availability of headers is * event first. The implicit availability of headers is for users and
* for users and pure (!) theme developers ONLY. * pure (!) theme developers ONLY.
* *
* @see Pico::getFileMeta() * @see Pico::getFileMeta()
* *
@ -2109,10 +2109,10 @@ class Pico
* to a string representing a page ID. * to a string representing a page ID.
* *
* @param string $page ID of the page to link to * @param string $page ID of the page to link to
* @param array|string $queryData either an array containing properties to * @param array|string|null $queryData either an array of properties to
* create a URL-encoded query string from, or a already encoded string * create a URL-encoded query string from, or a already encoded string
* @param bool $dropIndex if the last path component is "index", * @param bool $dropIndex if the last path component is
* passing TRUE (default) leads to removing this path component * "index", passing TRUE (default) will remove this path component
* *
* @return string URL * @return string URL
*/ */