Hello friends of SPL,
A script now exists (phpdoc/scripts/check-missing-spldocs.php) that
tells us about missing and partially completed SPL documentation. It
makes a couple of assumptions (see script for details) but feel free
to use it.
If you're either working on something listed here or want to, then let
others know. An updated list will be posted here roughly every week
until we're done.
Here's the current output, and it's all considered open at this point:
Missing files:
Array
(
[0] => appenditerator/append.xml
[1] => appenditerator/construct.xml
[2] => appenditerator/current.xml
[3] => appenditerator/getarrayiterator.xml
[4] => appenditerator/getinneriterator.xml
[5] => appenditerator/getiteratorindex.xml
[6] => appenditerator/key.xml
[7] => appenditerator/next.xml
[8] => appenditerator/rewind.xml
[9] => appenditerator/valid.xml
[10] => appenditerator.xml
[11] => arrayiterator/append.xml
[12] => arrayiterator/asort.xml
[13] => arrayiterator/construct.xml
[14] => arrayiterator/count.xml
[15] => arrayiterator/getarraycopy.xml
[16] => arrayiterator/getflags.xml
[17] => arrayiterator/ksort.xml
[18] => arrayiterator/natcasesort.xml
[19] => arrayiterator/natsort.xml
[20] => arrayiterator/offsetexists.xml
[21] => arrayiterator/offsetget.xml
[22] => arrayiterator/offsetset.xml
[23] => arrayiterator/offsetunset.xml
[24] => arrayiterator/serialize.xml
[25] => arrayiterator/setflags.xml
[26] => arrayiterator/uasort.xml
[27] => arrayiterator/uksort.xml
[28] => arrayiterator/unserialize.xml
[29] => arrayobject/asort.xml
[30] => arrayobject/exchangearray.xml
[31] => arrayobject/getarraycopy.xml
[32] => arrayobject/getflags.xml
[33] => arrayobject/getiteratorclass.xml
[34] => arrayobject/ksort.xml
[35] => arrayobject/natcasesort.xml
[36] => arrayobject/natsort.xml
[37] => arrayobject/serialize.xml
[38] => arrayobject/setflags.xml
[39] => arrayobject/setiteratorclass.xml
[40] => arrayobject/uasort.xml
[41] => arrayobject/uksort.xml
[42] => arrayobject/unserialize.xml
[43] => directoryiterator/getbasename.xml
[44] => directoryiterator/seek.xml
[45] => directoryiterator/tostring.xml
[46] => emptyiterator/current.xml
[47] => emptyiterator/key.xml
[48] => emptyiterator/next.xml
[49] => emptyiterator/rewind.xml
[50] => emptyiterator/valid.xml
[51] => emptyiterator.xml
[52] => filteriterator/accept.xml
[53] => filteriterator/construct.xml
[54] => infiniteiterator/construct.xml
[55] => infiniteiterator/next.xml
[56] => infiniteiterator.xml
[57] => limititerator/construct.xml
[58] => limititerator/current.xml
[59] => limititerator/getinneriterator.xml
[60] => limititerator/key.xml
[61] => multipleiterator/attachiterator.xml
[62] => multipleiterator/construct.xml
[63] => multipleiterator/containsiterator.xml
[64] => multipleiterator/countiterators.xml
[65] => multipleiterator/current.xml
[66] => multipleiterator/detachiterator.xml
[67] => multipleiterator/getflags.xml
[68] => multipleiterator/key.xml
[69] => multipleiterator/next.xml
[70] => multipleiterator/rewind.xml
[71] => multipleiterator/setflags.xml
[72] => multipleiterator/valid.xml
[73] => multipleiterator.xml
[74] => norewinditerator/construct.xml
[75] => norewinditerator/current.xml
[76] => norewinditerator/getinneriterator.xml
[77] => norewinditerator/key.xml
[78] => norewinditerator/next.xml
[79] => norewinditerator/rewind.xml
[80] => norewinditerator/valid.xml
[81] => norewinditerator.xml
[82] => outeriterator/getinneriterator.xml
[83] => outeriterator.xml
[84] => parentiterator/accept.xml
[85] => parentiterator/construct.xml
[86] => recursivearrayiterator/getchildren.xml
[87] => recursivearrayiterator/haschildren.xml
[88] => recursivearrayiterator.xml
[89] => recursivecachingiterator/construct.xml
[90] => recursivedirectoryiterator/construct.xml
[91] => recursivedirectoryiterator/getsubpath.xml
[92] => recursivedirectoryiterator/getsubpathname.xml
[93] => recursivefilteriterator/construct.xml
[94] => recursivefilteriterator/getchildren.xml
[95] => recursivefilteriterator/haschildren.xml
[96] => recursivefilteriterator.xml
[97] => recursiveiterator/getchildren.xml
[98] => recursiveiterator/haschildren.xml
[99] => recursiveiterator.xml
[100] => recursiveiteratoriterator/beginchildren.xml
[101] => recursiveiteratoriterator/beginiteration.xml
[102] => recursiveiteratoriterator/callgetchildren.xml
[103] => recursiveiteratoriterator/callhaschildren.xml
[104] => recursiveiteratoriterator/construct.xml
[105] => recursiveiteratoriterator/endchildren.xml
[106] => recursiveiteratoriterator/enditeration.xml
[107] => recursiveiteratoriterator/getinneriterator.xml
[108] => recursiveiteratoriterator/getmaxdepth.xml
[109] => recursiveiteratoriterator/nextelement.xml
[110] => recursiveiteratoriterator/setmaxdepth.xml
[111] => recursiveregexiterator/construct.xml
[112] => recursiveregexiterator/getchildren.xml
[113] => recursiveregexiterator/haschildren.xml
[114] => recursiveregexiterator.xml
[115] => recursivetreeiterator/beginchildren.xml
[116] => recursivetreeiterator/beginiteration.xml
[117] => recursivetreeiterator/callgetchildren.xml
[118] => recursivetreeiterator/callhaschildren.xml
[119] => recursivetreeiterator/construct.xml
[120] => recursivetreeiterator/current.xml
[121] => recursivetreeiterator/endchildren.xml
[122] => recursivetreeiterator/enditeration.xml
[123] => recursivetreeiterator/getentry.xml
[124] => recursivetreeiterator/getpostfix.xml
[125] => recursivetreeiterator/getprefix.xml
[126] => recursivetreeiterator/key.xml
[127] => recursivetreeiterator/next.xml
[128] => recursivetreeiterator/nextelement.xml
[129] => recursivetreeiterator/rewind.xml
[130] => recursivetreeiterator/setprefixpart.xml
[131] => recursivetreeiterator/valid.xml
[132] => recursivetreeiterator.xml
[133] => regexiterator/accept.xml
[134] => regexiterator/construct.xml
[135] => regexiterator/getflags.xml
[136] => regexiterator/getmode.xml
[137] => regexiterator/getpregflags.xml
[138] => regexiterator/setflags.xml
[139] => regexiterator/setmode.xml
[140] => regexiterator/setpregflags.xml
[141] => regexiterator.xml
[142] => splfileobject/construct.xml
[143] => splfileobject/current.xml
[144] => splfileobject/eof.xml
[145] => splfileobject/fflush.xml
[146] => splfileobject/fgetc.xml
[147] => splfileobject/fgetcsv.xml
[148] => splfileobject/fgets.xml
[149] => splfileobject/fgetss.xml
[150] => splfileobject/flock.xml
[151] => splfileobject/fpassthru.xml
[152] => splfileobject/fscanf.xml
[153] => splfileobject/fseek.xml
[154] => splfileobject/fstat.xml
[155] => splfileobject/ftell.xml
[156] => splfileobject/ftruncate.xml
[157] => splfileobject/fwrite.xml
[158] => splfileobject/getchildren.xml
[159] => splfileobject/getcsvcontrol.xml
[160] => splfileobject/getcurrentline.xml
[161] => splfileobject/getflags.xml
[162] => splfileobject/getmaxlinelen.xml
[163] => splfileobject/haschildren.xml
[164] => splfileobject/key.xml
[165] => splfileobject/next.xml
[166] => splfileobject/rewind.xml
[167] => splfileobject/seek.xml
[168] => splfileobject/setcsvcontrol.xml
[169] => splfileobject/setflags.xml
[170] => splfileobject/setmaxlinelen.xml
[171] => splfileobject/tostring.xml
[172] => splfileobject/valid.xml
[173] => splfileobject.xml
[174] => splobserver/update.xml
[175] => splobserver.xml
[176] => splsubject/attach.xml
[177] => splsubject/detach.xml
[178] => splsubject/notify.xml
[179] => splsubject.xml
[180] => spltempfileobject/construct.xml
[181] => spltempfileobject.xml
)
Exist, but considered undocumented:
Array
(
[0] => arrayiterator/seek.xml
[1] => arrayobject/append.xml
[2] => arrayobject/count.xml
[3] => arrayobject/offsetexists.xml
[4] => arrayobject/offsetget.xml
[5] => arrayobject/offsetset.xml
[6] => arrayobject/offsetunset.xml
[7] => cachingiterator/construct.xml
[8] => cachingiterator/count.xml
[9] => cachingiterator/current.xml
[10] => cachingiterator/getcache.xml
[11] => cachingiterator/getflags.xml
[12] => cachingiterator/getinneriterator.xml
[13] => cachingiterator/hasnext.xml
[14] => cachingiterator/key.xml
[15] => cachingiterator/next.xml
[16] => cachingiterator/offsetexists.xml
[17] => cachingiterator/offsetget.xml
[18] => cachingiterator/offsetset.xml
[19] => cachingiterator/offsetunset.xml
[20] => cachingiterator/rewind.xml
[21] => cachingiterator/setflags.xml
[22] => cachingiterator/tostring.xml
[23] => cachingiterator/valid.xml
[24] => directoryiterator/current.xml
[25] => directoryiterator/getfilename.xml
[26] => directoryiterator/key.xml
[27] => directoryiterator/next.xml
[28] => directoryiterator/rewind.xml
[29] => directoryiterator/valid.xml
[30] => filesystemiterator/construct.xml
[31] => filesystemiterator/current.xml
[32] => filesystemiterator/getflags.xml
[33] => filesystemiterator/key.xml
[34] => filesystemiterator/next.xml
[35] => filesystemiterator/rewind.xml
[36] => filesystemiterator/setflags.xml
[37] => filteriterator/current.xml
[38] => filteriterator/getinneriterator.xml
[39] => filteriterator/key.xml
[40] => filteriterator/next.xml
[41] => filteriterator/rewind.xml
[42] => filteriterator/valid.xml
[43] => globiterator/construct.xml
[44] => globiterator/count.xml
[45] => limititerator/getposition.xml
[46] => limititerator/next.xml
[47] => limititerator/rewind.xml
[48] => limititerator/seek.xml
[49] => limititerator/valid.xml
[50] => recursivecachingiterator/getchildren.xml
[51] => recursivecachingiterator/haschildren.xml
[52] => recursivedirectoryiterator/getchildren.xml
[53] => recursivedirectoryiterator/haschildren.xml
[54] => recursiveiteratoriterator/current.xml
[55] => recursiveiteratoriterator/getdepth.xml
[56] => recursiveiteratoriterator/getsubiterator.xml
[57] => recursiveiteratoriterator/key.xml
[58] => recursiveiteratoriterator/next.xml
[59] => recursiveiteratoriterator/rewind.xml
[60] => recursiveiteratoriterator/valid.xml
[61] => seekableiterator/seek.xml
)
Stats for SPL Docs:
Number missing = 182 and undocumented: 62
