php/archived-php-src
1
0
Fork 0
mirror of https://github.com/php/php-src.git synced 2026-03-24 00:02:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Clarify usage of @deprecated annotation in stubs

Browse Source 
To indicate that this was used prior to the \Deprecated attribute being usable on those symbols.
This commit is contained in:
Gina Peter Banyard
2025-08-23 14:18:30 +02:00
parent 273d9e2901
commit fb27ff958c
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/miscellaneous/stubs.rst
View File

@@ -223,7 +223,8 @@ The generated ``class_Atmosphere_methods`` must be used when registering the ``A
Additional meta information can be attached to functions, with the following PHPDoc tags:
- ``@deprecated``: Triggers the usual deprecation notice when the function/method is called.
- ``@deprecated``: Triggers the usual deprecation notice when the function/method is called. As of
PHP 8.4.0 the `#[Deprecated]` attribute should be used instead.
- ``@alias``: If a function/method is an alias of another function/method, then the aliased
function/method name has to be provided as value. E.g. the function ``sizeof()`` has the ``@alias
@@ -452,7 +453,8 @@ with ``@cvalue M_PI`` to the C-level constant ``M_PI`` (define by PHP's internal
Constants can take the following extra meta information passed via PHPDoc tags:
- ``@deprecated``: Triggers a deprecation notice when the constant is used.
- ``@deprecated``: Triggers a deprecation notice when the constant is used. As of PHP 8.5.0 the
`#[Deprecated]` attribute should be used instead.
- ``@genstubs-expose-comment-block``: By adding this tag at the beginning of a PHPDoc block, the
content of the PHPDoc block will be exposed for `ReflectionClass::getDocComment()`. This feature