admin/doc-en
1
0
Fork 0
mirror of https://github.com/macintoshplus/doc-en.git synced 2026-03-24 17:02:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
29,838 Commits 2 Branches 0 Tags
master
Commit Graph

94 Commits

Author SHA1 Message Date
Fernando Wobeto
c5402f6655 Fix word in ReflectionConstant (#3352) 2024-04-27 22:34:24 +02:00
Yoshinari Takaoka
dfdaa9a77c [PHP 8.3] Return type of ReflectionClass::getStaticProperties() is no longer nullable. (#2920) 
Co-authored-by: Gina Peter Banyard <girgias@php.net>
 2023-11-14 23:46:34 +00:00
Alexandre Daubois
d52f1e6908 Fix GH-2421: Improve ReflectionClass example (#2612) 2023-07-31 14:21:47 +01:00
Tim Starling
ca840c9a6d Reflection: fix some "undocumented" methods, and some other edits for consistency (#2516) 
* If a method has a refpurpose, description, parameters and return
  values, it's documented, there's no need for the warning box.
* Add description where there was none. It is usually very similar
  to the refpurpose.
* Document ReflectionZendExtension::__construct(), and update
  ReflectionExtension::__construct() for consistency.
* In ReflectionFunction::__toString()
* Remove some references to deprecated export() methods.
* Add example for ReflectionParameter::__toString().
 2023-06-16 02:14:23 +01:00
Ollie Read
fadab82e11 Missing getAttributes documentation 
Closes GH-1567.
 2023-01-16 16:56:52 +01:00
othercorey
35c3bd55d6 Removed invalid return null description 
Closes GH-2153.
 2023-01-08 13:21:35 +01:00
othercorey
1ddcca66af Remove invalid null return description 
Closes GH-2152.
 2023-01-08 13:19:14 +01:00
Máté Kocsis
7f6236d76d Add role attribute for ReflectionClass::isReadOnly 2022-12-11 22:06:28 +01:00
Máté Kocsis
ec2fe9a592 Update ext/reflection role attributes (#1979) 2022-12-11 20:53:33 +01:00
Yoshinari Takaoka
a4f0588234 added ReflectionClass::isReadOnly documentation. (#2006) 
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
 2022-11-14 22:53:43 +09:00
Christoph M. Becker
7c30fe36eb Fix GH-1919: Doc comment must start with /** followed by whitespace 
While we're at it, we also fix the indentation of the example to match
common PHP formatting rules.
 2022-10-27 18:14:28 +02:00
魔王卷子
e23a1375a5 Fix example 
Closes GH-1910.
 2022-10-23 16:23:14 +02:00
Ollie Read
8d2b545eef Add missing documentation for the ReflectionClass::getAttributes method 
Closes GH-1539.
 2022-05-03 13:08:20 +02:00
George Peter Banyard
967b4787ba Remove return value section for Reflection constructors 2022-04-08 00:45:55 +01:00
Kamil Tekiela
ab58951f68 Remove &warn.undocumented.func; from Reflection 
Removed from all the places where it wasn't stricly necessary.

Closes GH-1217.
 2022-03-29 16:49:06 +02:00
Sammy
210b5020c0 Add trailing semicolon to getDocComment 
Although this is valid PHP, other functions' examples in the class (e.g. `getDefaultProperties` and `getConstructor`) contain this trailing semicolon.

Fixes GH-1432
Closes GH-1486.
 2022-03-28 14:09:48 +02:00
the-toster
a416cd2c01 ReflectionClass::isEnum method (#1390) 2022-02-14 13:58:13 -06:00
Máté Kocsis
1c1619047e Fix a few ext/reflection return types (#1208) 2021-12-16 14:28:35 +01:00
Máté Kocsis
b0b19b6618 Generate methodsynopses based on stubs for recent changes (#903) 2021-10-01 17:23:05 +02:00
George Peter Banyard
e1eff0924f Fix section order issues in Reflection extension 
Part of #658
 2021-06-06 18:03:03 +01:00
Yoshinari Takaoka
969080b592 Added ReflectionAttribute related Documentation. (#588) 
* Added ReflectionAttribute related Documentation.

* Update reference/reflection/reflectionattribute/isrepeated.xml

Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>

* Update reference/reflection/reflectionattribute/isrepeated.xml

Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>

* Update reference/reflection/reflectionattribute/newinstance.xml

Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>

* Update reference/reflection/reflectionattribute/newinstance.xml

Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>

* Update reference/reflection/reflectionclass/getattributes.xml

Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>

* Update reference/reflection/reflectionclassconstant/getattributes.xml

Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>

* Update reference/reflection/reflectionfunctionabstract/getattributes.xml

Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>

* Update reference/reflection/reflectionparameter/getattributes.xml

Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>

* Update reference/reflection/reflectionproperty/getattributes.xml

Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>

Co-authored-by: Benjamin Eberlei <kontakt@beberlei.de>
 2021-06-04 20:20:42 +09:00
Sergey Panteleev
184f3f7bd4 Remove PHP 5, 7 references (#565) 2021-05-12 14:49:16 +03:00
Yoshinari Takaoka
d3191e2f3c replaced deprected warning with deprecated-removed one. 2021-05-02 14:18:03 +09:00
Sergey Panteleev
5fabd07880 Removed Changelog entries for PHP 5, PHP 7.0 (#543) 2021-04-22 17:52:58 +03:00
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