2009/3/31 Philip Olson <phi...@roshambo.org>: > >>>> So is there anything I can do? > >>> My question is, were those statistics about undocumented functions etc. a >>> result of problems with PhD or a genuine reflection of functions that are >>> missing documentation? My guess is the latter... > >> How feasible would it be to add a "to" attribute to the version.xml >> entries. >> >> It should move us towards getting a more accurate index. >> >> The issue of OOP/procedural entries is akward, but theoretically, they >> should be indexed separately as MAYBE the OOP interface was added at a >> later date. > > Having separate OO entries is one step as some do it whereas others do not. > The files need cleaned up if they are going to be used for tasks like > creating a base for funcindex.xml because for various reasons they are not > meant for this. Results for "undocumented" happen for many reasons, as > described earlier. Summary of them: > > - Current reliance on formatting by both configure.php and Phd (ex. - vs _) > - We don't document many of the old aliases, yet keep version information > (which is fine) > - OO versus Procedural tracking and formatting -- is inconsistent > - They are in fact not documented (these are okay to have in the > funcindex.xml) > - All versions.xml are not perfect (I assume other problems exist too) > > However, let's realize that versions files are meant to perform one task: > track version information. That said, what would this "to" attribute mean or > do? >
The life of a function started with a particular PHP/PECL version (the "from" attribute"). If a function is deprecated, you could either incorporate the final version into the "from" attribute in some way or have a "to" attribute. The "to" attribute would provide a clear indication of the final version of the function/method. Only those functions without a "to" attribute would be considered "live". With this attribute version.xml would now be tracking the entire life of the function/method in an easy to use way. > Summary: As is the version files work [almost] perfectly for the current > task, but not for any other. And many of the "undocumented" results are > bogus. > > Regards, > Philip > > > -- ----- Richard Quadling Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498&r=213474731 "Standing on the shoulders of some very clever giants!"
