Repository navigation
Files still using &warn.undocumented.func; #5786
Description
Context
&warn.undocumented.func; renders as "This function is currently not documented; only its argument list is available." It is still used in 302 files, spread over 24 extensions. On those pages a reader gets a signature and nothing else: no behaviour, no parameter semantics, no return value description.
This is a tracking issue, not a proposal to change anything about the entity itself. It just puts the remaining occurrences in one place so they can be picked up individually.
Scope
Extensions planned to move to the third-party extension manual are excluded. The filter used is the target column of the migration table in php/doc-extensions#12, so only books that stay in this manual are listed.
The list reflects the state of master at the time of writing and may drift slightly as pages are fixed.
How to help
Pick any file, write the missing description, remove the entity. There is no need to claim a whole extension: one file is a perfectly good contribution, and the small ones (ftp, image, posix, soap, ...) are a reasonable place to start.
- A file counts as done once
&warn.undocumented.func;is gone and replaced by a real description of what the function or method does. - Filling in the parameter and return value sections is welcome but not required for the entity to go.
- Ticking the box below (or naming the file in the pull request) helps avoid two people writing the same page.
The occurrences can be re-derived at any time with:
$ grep -rl 'warn.undocumented.func' reference/Remaining files
reference/spl (108)
-
reference/spl/arrayiterator/append.xml -
reference/spl/arrayiterator/construct.xml -
reference/spl/arrayiterator/count.xml -
reference/spl/arrayiterator/getarraycopy.xml -
reference/spl/arrayiterator/offsetexists.xml -
reference/spl/arrayiterator/offsetget.xml -
reference/spl/arrayiterator/offsetset.xml -
reference/spl/arrayiterator/serialize.xml -
reference/spl/arrayiterator/unserialize.xml -
reference/spl/arrayobject/serialize.xml -
reference/spl/arrayobject/unserialize.xml -
reference/spl/cachingiterator/construct.xml -
reference/spl/cachingiterator/count.xml -
reference/spl/cachingiterator/current.xml -
reference/spl/cachingiterator/getflags.xml -
reference/spl/cachingiterator/hasnext.xml -
reference/spl/cachingiterator/key.xml -
reference/spl/cachingiterator/next.xml -
reference/spl/cachingiterator/offsetexists.xml -
reference/spl/cachingiterator/offsetget.xml -
reference/spl/cachingiterator/offsetset.xml -
reference/spl/cachingiterator/offsetunset.xml -
reference/spl/cachingiterator/rewind.xml -
reference/spl/cachingiterator/setflags.xml -
reference/spl/cachingiterator/tostring.xml -
reference/spl/cachingiterator/valid.xml -
reference/spl/emptyiterator/current.xml -
reference/spl/emptyiterator/key.xml -
reference/spl/emptyiterator/next.xml -
reference/spl/emptyiterator/rewind.xml -
reference/spl/filteriterator/construct.xml -
reference/spl/filteriterator/current.xml -
reference/spl/filteriterator/key.xml -
reference/spl/filteriterator/next.xml -
reference/spl/filteriterator/rewind.xml -
reference/spl/multipleiterator/attachiterator.xml -
reference/spl/multipleiterator/containsiterator.xml -
reference/spl/multipleiterator/countiterators.xml -
reference/spl/multipleiterator/current.xml -
reference/spl/multipleiterator/detachiterator.xml -
reference/spl/multipleiterator/getflags.xml -
reference/spl/multipleiterator/key.xml -
reference/spl/multipleiterator/next.xml -
reference/spl/multipleiterator/rewind.xml -
reference/spl/multipleiterator/setflags.xml -
reference/spl/multipleiterator/valid.xml -
reference/spl/norewinditerator/current.xml -
reference/spl/norewinditerator/key.xml -
reference/spl/norewinditerator/next.xml -
reference/spl/norewinditerator/valid.xml -
reference/spl/parentiterator/accept.xml -
reference/spl/parentiterator/construct.xml -
reference/spl/parentiterator/getchildren.xml -
reference/spl/parentiterator/haschildren.xml -
reference/spl/parentiterator/next.xml -
reference/spl/parentiterator/rewind.xml -
reference/spl/recursivecachingiterator/construct.xml -
reference/spl/recursivecachingiterator/getchildren.xml -
reference/spl/recursivecachingiterator/haschildren.xml -
reference/spl/recursivedirectoryiterator/getchildren.xml -
reference/spl/recursivedirectoryiterator/haschildren.xml -
reference/spl/recursivedirectoryiterator/key.xml -
reference/spl/recursivedirectoryiterator/next.xml -
reference/spl/recursivedirectoryiterator/rewind.xml -
reference/spl/recursiveiteratoriterator/beginchildren.xml -
reference/spl/recursiveiteratoriterator/beginiteration.xml -
reference/spl/recursiveiteratoriterator/callhaschildren.xml -
reference/spl/recursiveiteratoriterator/current.xml -
reference/spl/recursiveiteratoriterator/endchildren.xml -
reference/spl/recursiveiteratoriterator/enditeration.xml -
reference/spl/recursiveiteratoriterator/getdepth.xml -
reference/spl/recursiveiteratoriterator/getinneriterator.xml -
reference/spl/recursiveiteratoriterator/getmaxdepth.xml -
reference/spl/recursiveiteratoriterator/getsubiterator.xml -
reference/spl/recursiveiteratoriterator/key.xml -
reference/spl/recursiveiteratoriterator/next.xml -
reference/spl/recursiveiteratoriterator/nextelement.xml -
reference/spl/recursiveiteratoriterator/rewind.xml -
reference/spl/recursiveiteratoriterator/setmaxdepth.xml -
reference/spl/recursiveiteratoriterator/valid.xml -
reference/spl/recursivetreeiterator/beginchildren.xml -
reference/spl/recursivetreeiterator/beginiteration.xml -
reference/spl/recursivetreeiterator/callgetchildren.xml -
reference/spl/recursivetreeiterator/callhaschildren.xml -
reference/spl/recursivetreeiterator/construct.xml -
reference/spl/recursivetreeiterator/current.xml -
reference/spl/recursivetreeiterator/endchildren.xml -
reference/spl/recursivetreeiterator/enditeration.xml -
reference/spl/recursivetreeiterator/getentry.xml -
reference/spl/recursivetreeiterator/getpostfix.xml -
reference/spl/recursivetreeiterator/getprefix.xml -
reference/spl/recursivetreeiterator/key.xml -
reference/spl/recursivetreeiterator/next.xml -
reference/spl/recursivetreeiterator/nextelement.xml -
reference/spl/recursivetreeiterator/rewind.xml -
reference/spl/recursivetreeiterator/setpostfix.xml -
reference/spl/recursivetreeiterator/setprefixpart.xml -
reference/spl/recursivetreeiterator/valid.xml -
reference/spl/regexiterator/getregex.xml -
reference/spl/spldoublylinkedlist/serialize.xml -
reference/spl/spldoublylinkedlist/unserialize.xml -
reference/spl/splfixedarray/serialize.xml -
reference/spl/splfixedarray/unserialize.xml -
reference/spl/splobserver/update.xml -
reference/spl/splpriorityqueue/getextractflags.xmlhttps://github.com/php/doc-en/pull/5981/changes -
reference/spl/splsubject/attach.xml -
reference/spl/splsubject/detach.xml -
reference/spl/splsubject/notify.xml
reference/intl (81)
-
reference/intl/intlbreakiterator/createcharacterinstance.xml -
reference/intl/intlbreakiterator/createcodepointinstance.xml -
reference/intl/intlbreakiterator/createlineinstance.xml -
reference/intl/intlbreakiterator/createsentenceinstance.xml -
reference/intl/intlbreakiterator/createtitleinstance.xml -
reference/intl/intlbreakiterator/createwordinstance.xml -
reference/intl/intlbreakiterator/current.xml -
reference/intl/intlbreakiterator/first.xml -
reference/intl/intlbreakiterator/following.xml -
reference/intl/intlbreakiterator/geterrorcode.xml -
reference/intl/intlbreakiterator/geterrormessage.xml -
reference/intl/intlbreakiterator/getlocale.xml -
reference/intl/intlbreakiterator/getpartsiterator.xml -
reference/intl/intlbreakiterator/gettext.xml -
reference/intl/intlbreakiterator/isboundary.xml -
reference/intl/intlbreakiterator/last.xml -
reference/intl/intlbreakiterator/next.xml -
reference/intl/intlbreakiterator/preceding.xml -
reference/intl/intlbreakiterator/previous.xml -
reference/intl/intlbreakiterator/settext.xml -
reference/intl/intlcodepointbreakiterator/getlastcodepoint.xml -
reference/intl/intlgregoriancalendar/construct.xml -
reference/intl/intliterator/current.xml -
reference/intl/intliterator/key.xml -
reference/intl/intliterator/next.xml -
reference/intl/intliterator/rewind.xml -
reference/intl/intliterator/valid.xml -
reference/intl/intlpartsiterator/getbreakiterator.xml -
reference/intl/intlrulebasedbreakiterator/construct.xml -
reference/intl/intlrulebasedbreakiterator/getbinaryrules.xml -
reference/intl/intlrulebasedbreakiterator/getrules.xml -
reference/intl/intlrulebasedbreakiterator/getrulestatus.xml -
reference/intl/intlrulebasedbreakiterator/getrulestatusvec.xml -
reference/intl/intltimezone/countequivalentids.xml -
reference/intl/intltimezone/createdefault.xml -
reference/intl/intltimezone/createenumeration.xml -
reference/intl/intltimezone/createtimezone.xml -
reference/intl/intltimezone/createtimezoneidenumeration.xml -
reference/intl/intltimezone/fromdatetimezone.xml -
reference/intl/intltimezone/getcanonicalid.xml -
reference/intl/intltimezone/getdisplayname.xml -
reference/intl/intltimezone/getdstsavings.xml -
reference/intl/intltimezone/getequivalentid.xml -
reference/intl/intltimezone/geterrorcode.xml -
reference/intl/intltimezone/geterrormessage.xml -
reference/intl/intltimezone/getgmt.xml -
reference/intl/intltimezone/getid.xml -
reference/intl/intltimezone/getidforwindowsid.xml -
reference/intl/intltimezone/getoffset.xml -
reference/intl/intltimezone/getrawoffset.xml -
reference/intl/intltimezone/getregion.xml -
reference/intl/intltimezone/gettzdataversion.xml -
reference/intl/intltimezone/getunknown.xml -
reference/intl/intltimezone/getwindowsid.xml -
reference/intl/intltimezone/hassamerules.xml -
reference/intl/intltimezone/todatetimezone.xml -
reference/intl/intltimezone/usedaylighttime.xml -
reference/intl/spoofchecker/setallowedlocales.xml -
reference/intl/transliterator/create.xml -
reference/intl/transliterator/createfromrules.xml -
reference/intl/transliterator/createinverse.xml -
reference/intl/transliterator/geterrorcode.xml -
reference/intl/transliterator/geterrormessage.xml -
reference/intl/uconverter/construct.xml -
reference/intl/uconverter/convert.xml -
reference/intl/uconverter/fromucallback.xml -
reference/intl/uconverter/getaliases.xml -
reference/intl/uconverter/getavailable.xml -
reference/intl/uconverter/getdestinationencoding.xml -
reference/intl/uconverter/getdestinationtype.xml -
reference/intl/uconverter/geterrorcode.xml -
reference/intl/uconverter/geterrormessage.xml -
reference/intl/uconverter/getsourceencoding.xml -
reference/intl/uconverter/getsourcetype.xml -
reference/intl/uconverter/getstandards.xml -
reference/intl/uconverter/getsubstchars.xml -
reference/intl/uconverter/reasontext.xml -
reference/intl/uconverter/setdestinationencoding.xml -
reference/intl/uconverter/setsourceencoding.xml -
reference/intl/uconverter/setsubstchars.xml -
reference/intl/uconverter/toucallback.xml
reference/reflection (21)
-
reference/reflection/reflection/export.xml -
reference/reflection/reflectionclassconstant/export.xml -
reference/reflection/reflectionobject/export.xml -
reference/reflection/reflectionparameter/clone.xml -
reference/reflection/reflectionparameter/export.xml -
reference/reflection/reflectionparameter/getclass.xml -
reference/reflection/reflectionparameter/iscallable.xml -
reference/reflection/reflectionproperty/clone.xml -
reference/reflection/reflectionproperty/export.xml -
reference/reflection/reflectionproperty/getrawvalue.xml -
reference/reflection/reflectionproperty/hashooks.xml -
reference/reflection/reflectionproperty/isfinal.xml -
reference/reflection/reflectionzendextension/clone.xml -
reference/reflection/reflectionzendextension/export.xml -
reference/reflection/reflectionzendextension/getauthor.xml -
reference/reflection/reflectionzendextension/getcopyright.xml -
reference/reflection/reflectionzendextension/getname.xml -
reference/reflection/reflectionzendextension/geturl.xml -
reference/reflection/reflectionzendextension/getversion.xml -
reference/reflection/reflectionzendextension/tostring.xml -
reference/reflection/reflector/export.xml
reference/sodium (19)
-
reference/sodium/functions/sodium-crypto-core-ristretto255-add.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-from-hash.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-is-valid-point.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-random.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-scalar-add.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-scalar-complement.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-scalar-invert.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-scalar-mul.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-scalar-negate.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-scalar-random.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-scalar-reduce.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-scalar-sub.xml -
reference/sodium/functions/sodium-crypto-core-ristretto255-sub.xml -
reference/sodium/functions/sodium-crypto-kx-seed-keypair.xml -
reference/sodium/functions/sodium-crypto-pwhash-scryptsalsa208sha256-str-verify.xml -
reference/sodium/functions/sodium-crypto-pwhash-scryptsalsa208sha256-str.xml -
reference/sodium/functions/sodium-crypto-scalarmult-ristretto255-base.xml -
reference/sodium/functions/sodium-crypto-scalarmult-ristretto255.xml -
reference/sodium/functions/sodium-crypto-shorthash-keygen.xml
reference/random (15)
-
reference/random/random/engine/mt19937/debuginfo.xml -
reference/random/random/engine/mt19937/generate.xml -
reference/random/random/engine/mt19937/serialize.xml -
reference/random/random/engine/mt19937/unserialize.xml -
reference/random/random/engine/pcgoneseq128xslrr64/debuginfo.xml -
reference/random/random/engine/pcgoneseq128xslrr64/generate.xml -
reference/random/random/engine/pcgoneseq128xslrr64/serialize.xml -
reference/random/random/engine/pcgoneseq128xslrr64/unserialize.xml -
reference/random/random/engine/xoshiro256starstar/debuginfo.xml -
reference/random/random/engine/xoshiro256starstar/generate.xml -
reference/random/random/engine/xoshiro256starstar/serialize.xml -
reference/random/random/engine/xoshiro256starstar/unserialize.xml -
reference/random/random/randomizer/construct.xml -
reference/random/random/randomizer/serialize.xml -
reference/random/random/randomizer/unserialize.xml
reference/ffi (14)
-
reference/ffi/ctype/getalignment.xml -
reference/ffi/ctype/getarrayelementtype.xml -
reference/ffi/ctype/getarraylength.xml -
reference/ffi/ctype/getattributes.xml -
reference/ffi/ctype/getenumkind.xml -
reference/ffi/ctype/getfuncabi.xml -
reference/ffi/ctype/getfuncreturntype.xml -
reference/ffi/ctype/getkind.xml -
reference/ffi/ctype/getname.xml -
reference/ffi/ctype/getpointertype.xml -
reference/ffi/ctype/getsize.xml -
reference/ffi/ctype/getstructfieldnames.xml -
reference/ffi/ctype/getstructfieldoffset.xml -
reference/ffi/ctype/getstructfieldtype.xml
reference/ldap (8)
-
reference/ldap/functions/ldap-connect-wallet.xml -
reference/ldap/functions/ldap-first-reference.xml -
reference/ldap/functions/ldap-next-reference.xml -
reference/ldap/functions/ldap-parse-reference.xml -
reference/ldap/functions/ldap-sasl-bind.xml -
reference/ldap/functions/ldap-set-rebind-proc.xml -
reference/ldap/functions/ldap-start-tls.xml -
reference/ldap/functions/ldap-t61-to-8859.xml
reference/mysqli (5)
-
reference/mysqli/mysqli_driver/embedded-server-end.xml -
reference/mysqli/mysqli_driver/embedded-server-start.xml -
reference/mysqli/mysqli_result/getiterator.xml -
reference/mysqli/mysqli_stmt/get-warnings.xml -
reference/mysqli/mysqli_stmt/insert-id.xmlDocument mysqli_stmt_insert_id #5945
reference/phpdbg (4)
-
reference/phpdbg/functions/phpdbg-end-oplog.xml -
reference/phpdbg/functions/phpdbg-exec.xml -
reference/phpdbg/functions/phpdbg-get-executable.xml -
reference/phpdbg/functions/phpdbg-start-oplog.xml
reference/sockets (4)
-
reference/sockets/functions/socket-cmsg-space.xml -
reference/sockets/functions/socket-export-stream.xml -
reference/sockets/functions/socket-recvmsg.xml -
reference/sockets/functions/socket-sendmsg.xml
reference/zlib (3)
-
reference/zlib/functions/inflate-get-read-len.xml -
reference/zlib/functions/zlib-decode.xml -
reference/zlib/functions/zlib-encode.xml
reference/gmp (2)
-
reference/gmp/gmp/serialize.xml -
reference/gmp/gmp/unserialize.xml
reference/hash (2)
-
reference/hash/hashcontext/serialize.xml -
reference/hash/hashcontext/unserialize.xml
reference/openssl (2)
-
reference/openssl/functions/openssl-cms-read.xmlopenssl_cms_read - docs added #5951 -
reference/openssl/functions/openssl-pkcs7-read.xml
reference/pdo_sqlite (2)
-
reference/pdo_sqlite/pdo/sqlite/loadextension.xml -
reference/pdo_sqlite/pdo/sqlite/openblob.xml
reference/phar (2)
-
reference/phar/Phar/getAlias.xml -
reference/phar/Phar/getPath.xml
reference/pspell (2)
-
reference/pspell/functions/pspell-config-data-dir.xml -
reference/pspell/functions/pspell-config-dict-dir.xml
reference/stream (2)
-
reference/stream/functions/stream-bucket-append.xml -
reference/stream/functions/stream-bucket-new.xml
reference/ftp (1)
-
reference/ftp/functions/ftp-append.xml
reference/image (1)
-
reference/image/functions/imageaffine.xml
reference/pdo (1)
-
reference/pdo/pdostatement/getiterator.xml
reference/pgsql (1)
-
reference/pgsql/functions/pg-socket.xml
reference/posix (1)
-
reference/posix/functions/posix-pathconf.xml
reference/soap (1)
-
reference/soap/soapclient/getcookies.xml
Activity