Add details to @deprecated tags

This commit is contained in:
Giuseppe Criscione 2020-12-14 16:26:58 +01:00
parent a23fb90826
commit ce751dd279
5 changed files with 9 additions and 10 deletions

View File

@ -237,7 +237,7 @@ class User extends DataGetter
/**
* @inheritdoc
*
* @deprecated
* @deprecated Access data directly from class methods
*/
public function get($key, $default = null)
{

View File

@ -49,7 +49,7 @@ class Page extends AbstractPage
*
* @var string
*
* @deprecated
* @deprecated Use the name property
*/
protected $id;
@ -426,7 +426,7 @@ class Page extends AbstractPage
*
* @return string|null File path or null if file is not found
*
* @deprecated
* @deprecated Access files from Page::files()
*/
public function file(string $file): ?string
{

View File

@ -184,7 +184,7 @@ class Site extends AbstractPage
/**
* Get site language
*
* @deprecated
* @deprecated Use Site::languages()->default() instead
*/
public function lang(): ?string
{

View File

@ -489,8 +489,7 @@ class FileSystem
/**
* Alias of createFile method
*
* @deprecated
* @see FileSystem::createFile()
* @deprecated Use FileSystem::createFile() instead
*/
public static function create(string $file): bool
{
@ -501,7 +500,7 @@ class FileSystem
/**
* Return a path with a single trailing slash
*
* @deprecated
* @deprecated Use FileSystem::normalizePath($path . DS) instead
*/
public static function normalize(string $path): string
{
@ -528,7 +527,7 @@ class FileSystem
/**
* Scan a path for files and directories
*
* @deprecated
* @deprecated Use generator-based FileSystem::listContents() instead
*
* @param bool $all Whether to return only visible or all files
*/
@ -553,7 +552,7 @@ class FileSystem
/**
* Recursively scan a path for files and directories
*
* @deprecated
* @deprecated Use generator-based FileSystem::listRecursive() instead
*
* @param bool $all Whether to return only visible or all files
*/

View File

@ -271,7 +271,7 @@ class Uri
/**
* Resolve a relative URI against current or a given base URI
*
* @deprecated
* @deprecated Use Uri::resolveRelativeUri() instead
*/
public static function resolveRelativeUri(string $uri, string $base = null): string
{