PEAR Documentation coverage analysis

Hello all, I finished a first version of the PEAR documentation coverage analysis tool: http://xml.cweiske.de/peardoc-coverage-simple.html http://xml.cweiske.de/peardoc-coverage-extendet.html http://xml.cweiske.de/QA_Peardoc_Coverage-0.1.0.tgz It basically wants the path to the peardoc cvs directory, and the pear cvs directory. Then it compares the packages in pear cvs with the ones documented in the manual and generates some statistics. The extendet version also shows which classes and methods are documented. Especially the class/method coverage is very basic and probably does more wrong than right, but it is very hard to map class and method names to the id attributes in peardoc (since they're free to choose), and the method-from-phpfile-detection isn't very good. Parent methods are not removed, too. It also opens the question if peardoc wants to be the ultimate reference (with examples AND api documentation), or merely a list of examples as the current coverage seems to imply. How to use it: 1. Install it pear install http://xml.cweiske.de/QA_Peardoc_Coverage-0.1.0.tgz 2. Generate serialized coverage data php /path/to/pearinstdir/docs/QA_Peardoc_Coverage/examples/genData.php /path/to/cvs/peardoc/manual.xml /path/to/cvs/pear/ 3. Generate simple html analysis php /path/to/pearinstdir/docs/QA_Peardoc_Coverage/examples/genSimpleStats.php /path/to/cvs/peardoc/manual.xml /path/to/cvs/pear/ > simple.html 4. Generate extendet html analysis php /path/to/pearinstdir/docs/QA_Peardoc_Coverage/examples/genExtendetStats.php /path/to/cvs/peardoc/manual.xml /path/to/cvs/pear/ > extendet.html The serialized coverage generation is not necessary, but very helpful since parsing the whole peardoc tree and comparing it with pear cvs takes some more seconds. -- Regards/MfG, Christian Weiske

Attachment: [application/pgp-signature] OpenPGP digital signature signature.asc