Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 1.5.0a1

Bug #12704 XML/Beautifier removed comment in XML Docbook peardoc2 converter template
Submitted: 2007-12-16 20:31 UTC
From: farell Assigned: ashnazg
Status: Closed Package: PhpDocumentor (version 1.4.1)
PHP Version: 5.2.5 OS: windows xp
Roadmaps: 1.4.4    

 [2007-12-16 20:31 UTC] farell (Laurent Laville)
Description: ------------ While trying to generate API doc for PEAR manual in DocBook format, I found that with XML/Beautifier (1.1) installed I got all comment tags dropped to final result : xml files For example, with a config file to generate PEAR_Info package API in command line pear_info.ini content : [Parse Data] title = PEAR_Info Manual hidden = false parseprivate = off javadocdesc = off defaultcategoryname = PEAR defaultpackagename = PEAR_Info target = C:\php5\phpdoc\PEAR_Info readmeinstallchangelog = README, INSTALL, FAQ, LICENSE directory = c:/php/pear/PEAR_Info ignore = CVS/* output=XML:DocBook/peardoc2:default sourcecode = on Test script: --------------- phpdoc -c pear_info.ini Expected result: ---------------- <!-- $Revision: 1.3 $ --> <refentry id="package.pear.pear-info.pear-info.display"> ... more xml tags ... </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Actual result: -------------- <refentry id="package.pear.pear-info.pear-info.display"> ... more xml tags ... </refentry>


 [2009-07-21 21:32 UTC] ashnazg (Chuck Burgess)
-Roadmap Versions: +Roadmap Versions: 1.4.3
 [2009-10-12 21:47 UTC] ashnazg (Chuck Burgess)
-Status: Open +Status: Verified
 [2009-10-13 03:08 UTC] ashnazg (Chuck Burgess)
-Status: Verified +Status: Closed -Assigned To: +Assigned To: ashnazg
Found issue in Converters/XML/DocBook/peardoc2/Tokenizer.php. When XML_Beautifier is available, this local Tokenizer extends its Tokenizer and makes a call to XML_Beautifier_Tokenizer::_handleXMLDefault(), which takes only one arg. However, the call to it passes two args, the first of which is *always* "false". This resulted in the comment data not even being seen. Committed fix to SVN.