Máté Kocsis
98df2cf9a9
Generate reflection methodsynopses based on stubs
...
We also document the new `$filter` parameter for the `ReflectionClass`
methods `::getConstants()` and `::getReflectionConstants()` and the
respective constants.
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
Closes GH-298.
2020-12-31 17:03:54 +01:00
Christoph Michael Becker
565b5f3de9
Fix example output for PHP 7.0.0 and up
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352077 c90b9560-bf6c-de11-be94-00142212c4b1
2020-12-14 20:10:29 +00:00
Christoph Michael Becker
4754397753
Revert revision 351727 from phpdoc/en/trunk:
...
Document false and null return types
Cf. <https://news-web.php.net/php.doc.cvs/17645 >.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351729 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-28 17:58:32 +00:00
Jakub Vrana
69bd53265b
Document false and null return types
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351727 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-28 15:12:46 +00:00
Christoph Michael Becker
831603509b
Fix return type
...
This integrates user note 125527.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351494 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-22 13:32:41 +00:00
Christoph Michael Becker
91de67290f
Fix #78707 : ReflectionClass::implementsInterface - incomplete documentation
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351217 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-04 11:40:49 +00:00
Christoph Michael Becker
86e6094e86
Use canonical type names
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351133 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 15:39:04 +00:00
Christoph Michael Becker
9e0f03ac35
Proper variadics instead of pseudo variadics
...
We markup variadic parameters with the `rep=repeat` standard DocBook
attribute of `<methodparam>`, and use proper variable names instead of
using the old pseudo variable name `...`.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351129 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 11:17:26 +00:00
Christoph Michael Becker
a465b89916
Reflection*::export is deprecated as of PHP 7.4.0
...
Seems we're overdue actually documenting these methods.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350501 c90b9560-bf6c-de11-be94-00142212c4b1
2020-09-03 08:59:26 +00:00
Christoph Michael Becker
bab9e5ad7f
Fix parameter type and description
...
Patch provided by Jochem Klaver.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346993 c90b9560-bf6c-de11-be94-00142212c4b1
2019-03-11 12:47:04 +00:00
Christoph Michael Becker
f9e14201d4
Improve docs
...
Patch provided by Florian Berberich.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346901 c90b9560-bf6c-de11-be94-00142212c4b1
2019-02-25 11:37:39 +00:00
Christoph Michael Becker
1046d428ad
Unify ReflectionClass::isIterateable() and ::isIterable() and make the former an alias
...
Cf. <http://git.php.net/?p=php-src.git;a=commit;h=c1500f8519aded29c3632de4240fbc0a4e485a81 >.
This integrates user note 123629.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346865 c90b9560-bf6c-de11-be94-00142212c4b1
2019-02-21 08:37:26 +00:00
Christoph Michael Becker
962214a5cc
Simplify signature of variadic functions
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346102 c90b9560-bf6c-de11-be94-00142212c4b1
2018-11-27 19:09:14 +00:00
Christoph Michael Becker
2992085869
Correct return value (false instead of null)
...
Patch provided by anonymous user.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344986 c90b9560-bf6c-de11-be94-00142212c4b1
2018-05-08 12:47:13 +00:00
Christoph Michael Becker
fce2efe7bb
Extend example
...
Patch provided by anonymous user.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344860 c90b9560-bf6c-de11-be94-00142212c4b1
2018-04-27 13:50:44 +00:00
Christoph Michael Becker
1af3f3f391
In docs, value to be set into static property can only be string, which doesn't make sense, and contradicts actual engine prototype: 12c386f5b9/ext/reflection/php_reflection.c (L3904)
...
--
Provided by anonymous 63059 (alex@kurilo.me )
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344476 c90b9560-bf6c-de11-be94-00142212c4b1
2018-03-09 13:04:58 +00:00
Christoph Michael Becker
a2165b1ec5
Fix typos
...
Patches provided by anonymous users.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344377 c90b9560-bf6c-de11-be94-00142212c4b1
2018-02-27 13:46:38 +00:00
Jakub Vrana
608edf885e
Document null return value (bug #75376 )
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344004 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-28 13:11:27 +00:00
Jakub Vrana
5f6c0c7994
Document PHP 7.2 functions
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343928 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-26 13:20:18 +00:00
Jakub Vrana
b8758b0605
Use entities in initializer
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343899 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-25 19:11:34 +00:00
Jakub Vrana
dd07341fae
Remove trailing fullstop in <refpurpose>
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343888 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-25 15:34:22 +00:00
Christoph Michael Becker
481c11df80
Fix see-also sections
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342902 c90b9560-bf6c-de11-be94-00142212c4b1
2017-08-21 12:11:15 +00:00
Christoph Michael Becker
cf616ef1f0
Fix bug #74261 : ReflectionClassConstant not documented
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342886 c90b9560-bf6c-de11-be94-00142212c4b1
2017-08-20 14:40:15 +00:00
Christoph Michael Becker
c957c1054f
Fix #74245 : No other ways to get all constants from class but using reflection
...
We're not actually fixing this issue, but rather document
ReflectionClass::getConstants().
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342147 c90b9560-bf6c-de11-be94-00142212c4b1
2017-03-17 12:25:04 +00:00
Andrey Andreev
584095e7e8
Consistent description of getModifiers() in ReflectionClass, ReflectionMethod, ReflectionProperty
...
(relevant for the 'seealso' section on Reflection::getModifierNames())
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342105 c90b9560-bf6c-de11-be94-00142212c4b1
2017-03-13 09:28:54 +00:00
Christoph Michael Becker
b11f2fefd5
Improvements provided by anon users
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@340325 c90b9560-bf6c-de11-be94-00142212c4b1
2016-10-05 14:32:17 +00:00
Christoph Michael Becker
992b071c3d
Fix #73195 : ReflectionClass::getMethod() filter arguments doesn't accept combinations
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@340255 c90b9560-bf6c-de11-be94-00142212c4b1
2016-09-29 10:12:50 +00:00
Christoph Michael Becker
e147cb1555
Fix method proto (patch provided by Gert)
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339981 c90b9560-bf6c-de11-be94-00142212c4b1
2016-09-03 23:57:28 +00:00
Thomas Punt
102a7f2b5e
Resolve doc bug #71279
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338410 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-06 19:01:14 +00:00
Chris Wright
2d5437d72e
Description for $def_value arg for ReflectionClass::getStaticPropertyValue()
...
--
Provided by anonymous 48107 (sun@unleashedmind.com )
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334684 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-01 13:19:21 +00:00
Adam Harvey
da75c15e02
Update the changed functions list, and integrate the changes into the text.
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334639 c90b9560-bf6c-de11-be94-00142212c4b1
2014-08-28 05:47:47 +00:00
Peter Cowburn
e288960f91
Better variable name in example
...
Patch by Arjen Schol
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334003 c90b9560-bf6c-de11-be94-00142212c4b1
2014-06-28 19:18:26 +00:00
Sebastian Bergmann
656d1610af
Add missing modifier information. Patch by Jeff Welch <whatthejeff@gmail.com>.
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330543 c90b9560-bf6c-de11-be94-00142212c4b1
2013-06-18 05:36:30 +00:00
Jakub Vrana
a592ee62e5
Document new method parameters
...
Checked with http://pastebin.com/PQKzkuQK
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330271 c90b9560-bf6c-de11-be94-00142212c4b1
2013-05-17 19:01:19 +00:00
Jakub Vrana
24ec4b99df
Document new Reflection methods
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330252 c90b9560-bf6c-de11-be94-00142212c4b1
2013-05-16 21:25:05 +00:00
Reeze Xia
5070dab783
Typo fix
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330175 c90b9560-bf6c-de11-be94-00142212c4b1
2013-05-04 06:56:24 +00:00
Sherif Ramadan
a80683c2f5
Added note to documentat that this method is only intended to work with internal classes for getting the default value of static class properties.
...
Fixes bug #63370 also references bug #51581
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329237 c90b9560-bf6c-de11-be94-00142212c4b1
2013-01-19 14:45:34 +00:00
Hannes Magnusson
754904a133
Fixed #63654 ReflectionClass::getConstructor() can return null, not documented
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328599 c90b9560-bf6c-de11-be94-00142212c4b1
2012-12-02 05:25:05 +00:00
Jakub Vrana
fce1841930
getMethod() can throw
...
Also fix See also
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328225 c90b9560-bf6c-de11-be94-00142212c4b1
2012-11-02 19:03:10 +00:00
Justin Martin
f9202b651d
Documented many undocumented ReflectionClass methods.
...
Removed undocumented warnings from a couple of documented methods.
Removed $default parameter from ReflectionClass::getStaticPropertyValue method documentation, as its behaviour is undefined and seems to exist only as an artefact.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@325878 c90b9560-bf6c-de11-be94-00142212c4b1
2012-05-27 23:08:29 +00:00
Justin Martin
7d5c7b8c2b
Removed inaccessible __clone method from ReflectionClass. More likely to come in this regard.
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@325877 c90b9560-bf6c-de11-be94-00142212c4b1
2012-05-27 22:52:04 +00:00
Jakub Vrana
c0afbecbbf
Classes with private constructors are not instantiable
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324632 c90b9560-bf6c-de11-be94-00142212c4b1
2012-03-30 11:13:04 +00:00
Jakub Vrana
dbbf38affc
Classes with private constructors are not instantiable
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324631 c90b9560-bf6c-de11-be94-00142212c4b1
2012-03-30 11:11:35 +00:00
Jakub Vrana
a09f874049
ReflectionClass::isSubclassOf() checks also interfaces
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324630 c90b9560-bf6c-de11-be94-00142212c4b1
2012-03-30 11:06:21 +00:00
Jakub Vrana
fcddfb2551
Link directly to magic methods
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322136 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-12 15:01:15 +00:00
Alexander Moskaliov
29db338ddd
fix #60685
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@321947 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-09 10:10:32 +00:00
Jakub Vrana
8c6d47907a
Improve Reflection
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@321705 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-03 06:12:37 +00:00
Rafael Dohms
ee884bc377
Updated RefelctionClass::getMethod documentation to properly reflect the return as ReflectionMethod and not "object"
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@318215 c90b9560-bf6c-de11-be94-00142212c4b1
2011-10-19 14:11:00 +00:00
Richard Quadling
8b6d169424
Native EOL
...
Use consistent line terminator.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@317663 c90b9560-bf6c-de11-be94-00142212c4b1
2011-10-03 16:27:39 +00:00
Richard Quadling
a56106f691
Standardized on double quotes for attributes.
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@317502 c90b9560-bf6c-de11-be94-00142212c4b1
2011-09-30 14:21:51 +00:00