http://pear.php.net/bugs/search.php?cmd=display&package_name%5B0%5D=PhpDocumentor Search Results en-us pear-webmaster@lists.php.net pear-webmaster@lists.php.net hourly 1 2000-01-01T12:00+00:00 http://pear.php.net/gifs/pearsmall.gif http://pear.php.net/bugs http://pear.php.net/bugs/16784 PhpDocumentor Bug Reported by pluk77 2009-11-13T10:28:16+00:00 PHP: 5.2.5 OS: windows Package Version: 1.4.3 Description: ------------ The Default converter for CHM format is for some reason parsing most of the files twice, resulting in duplicate entries of those files in the files section. I have looked at the code, and it seems that writeSource() is beeing called twice per file which in turn calls writeFile() which in turn calls addHHP(). This results in each file beeing added twice to the $this->hhp_files[]['name'] array. Probably not the best way of fixing this, but better than manually removing the duplicate entries from the generated file, is adding a private array which keeps track of what files have already been parsed and an if statement that does not parse the file if is has been parsed already. class CHMdefaultConverter extends Converter { var $_filenames = array(); // rest of class function writeSource($path, $value) { if (!in_array($path,$this->_filenames)) { array_push($this->_filenames,$path); // rest of function } } Maybe someone with more knowledge of the conversion process can figure out why files are parsed twice and if this is required for the normal operation of the converter. Test script: --------------- output=CHM:default:default sourcecode = on Expected result: ---------------- All files to be parsed once and included in the [files] section of the CHM project once. Actual result: -------------- The are parsed twice and end up in the [files] section twice, causing errors during compiling of the CHM file and a bloated CHM file.]]> PhpDocumentor Bug Reported by pluk77 2009-11-13T10:28:16+00:00 PHP: 5.2.5 OS: windows Package Version: 1.4.3 Description: ------------ The Default converter for CHM format is for some reason parsing most of the files twice, resulting in duplicate entries of those files in the files section. I have looked at the code, and it seems that writeSource() is beeing called twice per file which in turn calls writeFile() which in turn calls addHHP(). This results in each file beeing added twice to the $this->hhp_files[]['name'] array. Probably not the best way of fixing this, but better than manually removing the duplicate entries from the generated file, is adding a private array which keeps track of what files have already been parsed and an if statement that does not parse the file if is has been parsed already. class CHMdefaultConverter extends Converter { var $_filenames = array(); // rest of class function writeSource($path, $value) { if (!in_array($path,$this->_filenames)) { array_push($this->_filenames,$path); // rest of function } } Maybe someone with more knowledge of the conversion process can figure out why files are parsed twice and if this is required for the normal operation of the converter. Test script: --------------- output=CHM:default:default sourcecode = on Expected result: ---------------- All files to be parsed once and included in the [files] section of the CHM project once. Actual result: -------------- The are parsed twice and end up in the [files] section twice, causing errors during compiling of the CHM file and a bloated CHM file.]]> 2009-11-13T10:28:16+00:00 marcel &#x61;&#116; berteler &#x64;&#111;&#x74; co &#x64;&#111;&#x74; za PhpDocumentor Bug http://pear.php.net/bugs/16542 PhpDocumentor Bug Reported by edo 2009-08-20T11:16:12+00:00 PHP: 5.2.5 OS: SUSE LINUX 10.1 (i586) Package Version: 1.4.2 Description: ------------ Hi, i've spent two hours trying to narrow down the repo case as good as possible. For example just removing the "@global array $aDbHostMap" (or about any other) line makes the error go away. Please not the trailing newlines in the file, removing those also made the error go away. I hope this report helps in any way since i had to spent hours to figure out what caused the error and i didn't come to any real conlusion, nor a way to fix it. Thank you for your time Test script: --------------- <?php /** * @author Volker Dusch <v.dusch@meteocontrol.de> * @copyright Copyright 2009, meteocontrol GmbH * * @package mclib.basis.db */ /** * You don't see me :/ * * @package mclib.basis.db */ class ThrowThings { /** * @global array $aDbHostMap */ public static function getConnection($sDb) { if (!isset($aDbHostMap[$sDb])) { throw new McDbException(); } if(isset(self::$aConnections[$sHost]) == false) { self::$aConnections[$sHost] = new McDb($sHost); } return self::$aConnections[$sHost]; } } Expected result: ---------------- The error shown in Actual Result shoudn't be thrown, the class documentation should be shown. Actual result: -------------- ThrowThings.class.php Warnings: Warning on line 18 - duplicate class element "ThrowThings" in file /daten/svnworkspace/vd/eclipse/std/mcdevelop/mclib/basis/db/ThrowThings.class.php will be ignored. Use an @ignore tag on the original if you want this case to be documented. Warning on line 18 - no @package tag was used in a DocBlock for class ThrowThings]]> PhpDocumentor Bug Reported by edo 2009-08-20T11:16:12+00:00 PHP: 5.2.5 OS: SUSE LINUX 10.1 (i586) Package Version: 1.4.2 Description: ------------ Hi, i've spent two hours trying to narrow down the repo case as good as possible. For example just removing the "@global array $aDbHostMap" (or about any other) line makes the error go away. Please not the trailing newlines in the file, removing those also made the error go away. I hope this report helps in any way since i had to spent hours to figure out what caused the error and i didn't come to any real conlusion, nor a way to fix it. Thank you for your time Test script: --------------- <?php /** * @author Volker Dusch <v.dusch@meteocontrol.de> * @copyright Copyright 2009, meteocontrol GmbH * * @package mclib.basis.db */ /** * You don't see me :/ * * @package mclib.basis.db */ class ThrowThings { /** * @global array $aDbHostMap */ public static function getConnection($sDb) { if (!isset($aDbHostMap[$sDb])) { throw new McDbException(); } if(isset(self::$aConnections[$sHost]) == false) { self::$aConnections[$sHost] = new McDb($sHost); } return self::$aConnections[$sHost]; } } Expected result: ---------------- The error shown in Actual Result shoudn't be thrown, the class documentation should be shown. Actual result: -------------- ThrowThings.class.php Warnings: Warning on line 18 - duplicate class element "ThrowThings" in file /daten/svnworkspace/vd/eclipse/std/mcdevelop/mclib/basis/db/ThrowThings.class.php will be ignored. Use an @ignore tag on the original if you want this case to be documented. Warning on line 18 - no @package tag was used in a DocBlock for class ThrowThings]]> 2009-11-23T21:37:19+00:00 v &#x64;&#111;&#x74; dusch &#x61;&#116; meteocontrol &#x64;&#111;&#x74; de PhpDocumentor Bug http://pear.php.net/bugs/16333 PhpDocumentor Feature/Change Request Reported by gauthierm 2009-06-16T02:32:00+00:00 PHP: Irrelevant OS: Irrelevant Package Version: Unknown Description: ------------ The @var documentation is put all on one line with no whitespace. This is fine for simple types but breaks for arrays where there is a default array defined Test script: --------------- See for example: http://pear.php.net/package/Console_CommandLine/docs/latest/Console_CommandLine/Console_CommandLine.html#var$actions Expected result: ---------------- A nicely formatted array. Actual result: -------------- An array jammed together with no whitespace that causes the page to be too wide to display correctly.]]> PhpDocumentor Feature/Change Request Reported by gauthierm 2009-06-16T02:32:00+00:00 PHP: Irrelevant OS: Irrelevant Package Version: Unknown Description: ------------ The @var documentation is put all on one line with no whitespace. This is fine for simple types but breaks for arrays where there is a default array defined Test script: --------------- See for example: http://pear.php.net/package/Console_CommandLine/docs/latest/Console_CommandLine/Console_CommandLine.html#var$actions Expected result: ---------------- A nicely formatted array. Actual result: -------------- An array jammed together with no whitespace that causes the page to be too wide to display correctly.]]> 2009-08-08T07:04:53+00:00 mike &#x61;&#116; silverorange &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/16270 PhpDocumentor Feature/Change Request Reported by janmoesen 2009-05-29T13:46:04+00:00 PHP: 5.2.9 OS: Package Version: 1.4.2 Description: ------------ When a docblock contains a <code> snippet, that snippet gets converted into a line-numbered block. (Ironically, the block doesn't even have <code> in it.) CODE is an inline HTML element. phpDocumentor acts like I wrote <pre><code>. http://www.w3.org/TR/REC-html40/struct/text.html#edef-CODE FWIW, this works correctly in JavaDoc. Test script: --------------- <?php /** * The Foo class stores <code>Bar->getFoo()</code> results. */ Expected result: ---------------- <p class="short-description">The Foo class stores <code><span class="src-id">Bar</span><span class="src-sym">-></span><span class="src-id">getFoo</span><span class="src-sym">(</span><span class="src-sym">)</span></code> results.</p> Actual result: -------------- <p class="short-description">The Foo class stores <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Bar</span><span class="src-sym">-></span><span class="src-id">getFoo</span><span class="src-sym">(</span><span class="src-sym">)</span></div></li> </ol></div> results.</p>]]> PhpDocumentor Feature/Change Request Reported by janmoesen 2009-05-29T13:46:04+00:00 PHP: 5.2.9 OS: Package Version: 1.4.2 Description: ------------ When a docblock contains a <code> snippet, that snippet gets converted into a line-numbered block. (Ironically, the block doesn't even have <code> in it.) CODE is an inline HTML element. phpDocumentor acts like I wrote <pre><code>. http://www.w3.org/TR/REC-html40/struct/text.html#edef-CODE FWIW, this works correctly in JavaDoc. Test script: --------------- <?php /** * The Foo class stores <code>Bar->getFoo()</code> results. */ Expected result: ---------------- <p class="short-description">The Foo class stores <code><span class="src-id">Bar</span><span class="src-sym">-></span><span class="src-id">getFoo</span><span class="src-sym">(</span><span class="src-sym">)</span></code> results.</p> Actual result: -------------- <p class="short-description">The Foo class stores <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Bar</span><span class="src-sym">-></span><span class="src-id">getFoo</span><span class="src-sym">(</span><span class="src-sym">)</span></div></li> </ol></div> results.</p>]]> 2009-07-21T16:38:38+00:00 pear &#x64;&#111;&#x74; php &#x64;&#111;&#x74; net &#x61;&#116; moesen &#x64;&#111;&#x74; nu PhpDocumentor Feature/Change Request http://pear.php.net/bugs/16223 PhpDocumentor Feature/Change Request Reported by stanv 2009-05-13T15:53:24+00:00 PHP: 5.2.9 OS: Any Package Version: 1.4.2 Description: ------------ There is no good way to type hint a method which returns $this. Currently we only can specify the current class, which works fine, unless we extend the class, example: class Foo { function fooMethod() {} /** * @return Foo */ function fluentMethod() { return $this; } } class Bar extends Foo { function barMethod() {} } $bar = new Bar(); // if you type the code below you will see a hint about // about fooMethod(), but not about barMethod() as there // is no way to type hint the dynamic nature of fluent // interfaces that return $this: $bar->fluentMethod()->... Suggested behavior and syntax: /** * @return self */ function fluentMethod() { return $this; } When the above syntax is used, Eclipse PDT will assume the return class is the same class that invokes the method, never mind where in the inheritance chain the method itself was declared. The same request was also filed for Eclipse PDT at: https://bugs.eclipse.org/bugs/show_bug.cgi?id=276082]]> PhpDocumentor Feature/Change Request Reported by stanv 2009-05-13T15:53:24+00:00 PHP: 5.2.9 OS: Any Package Version: 1.4.2 Description: ------------ There is no good way to type hint a method which returns $this. Currently we only can specify the current class, which works fine, unless we extend the class, example: class Foo { function fooMethod() {} /** * @return Foo */ function fluentMethod() { return $this; } } class Bar extends Foo { function barMethod() {} } $bar = new Bar(); // if you type the code below you will see a hint about // about fooMethod(), but not about barMethod() as there // is no way to type hint the dynamic nature of fluent // interfaces that return $this: $bar->fluentMethod()->... Suggested behavior and syntax: /** * @return self */ function fluentMethod() { return $this; } When the above syntax is used, Eclipse PDT will assume the return class is the same class that invokes the method, never mind where in the inheritance chain the method itself was declared. The same request was also filed for Eclipse PDT at: https://bugs.eclipse.org/bugs/show_bug.cgi?id=276082]]> 2009-07-21T16:38:08+00:00 pdtbugs &#x61;&#116; stanvassilev &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/15109 PhpDocumentor Feature/Change Request Reported by lapistano 2008-11-21T04:59:01+00:00 PHP: 5.2.0 OS: MacOsX Package Version: Description: ------------ Since it is possible to add multiple @param tags to a docblock it should be possible to add more than one @var tag, too. Imagine you want to do s.th like showed in the example. Since this is a valid PHP construct this should IMHO be supported by phpDocumentor. Test script: --------------- /** * Test for multiple @var tags in docblock * * @var integer $num Amount of anything * @var string $txt Description of anything */ public $num, $txt; Expected result: ---------------- This depends on the output filter but mainly phphDocumentor should not throw an error and should match each @var tag to the variable next in the sequence. Actual result: -------------- PhpDocumentor throws an error, telling you that is not allowed to have more than one @var tag in a docblock.]]> PhpDocumentor Feature/Change Request Reported by lapistano 2008-11-21T04:59:01+00:00 PHP: 5.2.0 OS: MacOsX Package Version: Description: ------------ Since it is possible to add multiple @param tags to a docblock it should be possible to add more than one @var tag, too. Imagine you want to do s.th like showed in the example. Since this is a valid PHP construct this should IMHO be supported by phpDocumentor. Test script: --------------- /** * Test for multiple @var tags in docblock * * @var integer $num Amount of anything * @var string $txt Description of anything */ public $num, $txt; Expected result: ---------------- This depends on the output filter but mainly phphDocumentor should not throw an error and should match each @var tag to the variable next in the sequence. Actual result: -------------- PhpDocumentor throws an error, telling you that is not allowed to have more than one @var tag in a docblock.]]> 2009-07-21T16:37:28+00:00 bastian &#x64;&#111;&#x74; feder &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/14981 PhpDocumentor Feature/Change Request Reported by kguest 2008-11-10T04:50:54+00:00 PHP: 5.2.6 OS: Package Version: Description: ------------ http://pear.php.net/package/PHP_Parser/docs/latest/ points to nowhere - there's a 404 error when attempting to view the latest api docs for that package. Test script: --------------- go to the package page for php_parser. click the "Documentation for the latest release" link admire the 404 error. Expected result: ---------------- to see autogenerated api docs Actual result: -------------- a hideous 404 error]]> PhpDocumentor Feature/Change Request Reported by kguest 2008-11-10T04:50:54+00:00 PHP: 5.2.6 OS: Package Version: Description: ------------ http://pear.php.net/package/PHP_Parser/docs/latest/ points to nowhere - there's a 404 error when attempting to view the latest api docs for that package. Test script: --------------- go to the package page for php_parser. click the "Documentation for the latest release" link admire the 404 error. Expected result: ---------------- to see autogenerated api docs Actual result: -------------- a hideous 404 error]]> 2009-06-01T22:07:48+00:00 ken &#x61;&#116; linux &#x64;&#111;&#x74; ie PhpDocumentor Feature/Change Request http://pear.php.net/bugs/14580 PhpDocumentor Feature/Change Request Reported by marisasmith 2008-08-30T07:11:26+00:00 PHP: 5.2.6 OS: Mac OS 10.5 Package Version: 1.4.2 Description: ------------ First of all, I LOVE PHPDocumentor! The documentation I am producing now is wonderful! The only complaint I have is the lack of support for documenting Javascript files, which are frequently part of a PHP developer's toolbox - especially now that AJAX is such a big part of a web developer's life. I tried using Doxygen, which does document JS files, but I prefer the web interface of PHPDoc and the smarty support to make my documentation look more professional. Please consider adding at minimum the ability to read the docblock tags added to a JS file - even if it doesn't automagically recognize functions, etc. it would be a great start to just have my comments and Todo's included with the rest of my documentation. Thanks again for the time you have put into developing this package - it is really fantastic! Marisa]]> PhpDocumentor Feature/Change Request Reported by marisasmith 2008-08-30T07:11:26+00:00 PHP: 5.2.6 OS: Mac OS 10.5 Package Version: 1.4.2 Description: ------------ First of all, I LOVE PHPDocumentor! The documentation I am producing now is wonderful! The only complaint I have is the lack of support for documenting Javascript files, which are frequently part of a PHP developer's toolbox - especially now that AJAX is such a big part of a web developer's life. I tried using Doxygen, which does document JS files, but I prefer the web interface of PHPDoc and the smarty support to make my documentation look more professional. Please consider adding at minimum the ability to read the docblock tags added to a JS file - even if it doesn't automagically recognize functions, etc. it would be a great start to just have my comments and Todo's included with the rest of my documentation. Thanks again for the time you have put into developing this package - it is really fantastic! Marisa]]> 2009-07-21T16:35:33+00:00 msmith &#x61;&#116; thewholebraingroup &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/14305 PhpDocumentor Bug Reported by farell 2008-07-07T16:34:07+00:00 PHP: 5.2.6 OS: Package Version: 1.4.2 Description: ------------ With a source with only @return phpdoc tag + variable type, and XML DocBook converter, the @return tag is not rendered ! Example 1: * @return array In this example, no return bloc rendered Example 2: * @return array or false on error In this example the "array" term is not rendered Expected result: ---------------- Example 1: <refsect1 id="package.php.php-compatinfo.php-compatinfo-parser.getdirlist.returns"> &title.returns; <para> <emphasis>returns</emphasis> array </para> </refsect1> Example 2: <refsect1 id="package.php.php-compatinfo.php-compatinfo-parser.getignoredfiles.returns"> &title.returns; <para> <emphasis>returns</emphasis> array or false on error </para> </refsect1> Actual result: -------------- Example 1: no refsect1 corresponding to &title.returns; was produced Example 2: <refsect1 id="package.php.php-compatinfo.php-compatinfo-parser.getignoredfiles.returns"> &title.returns; <para> <emphasis>returns</emphasis> or false on error </para> </refsect1>]]> PhpDocumentor Bug Reported by farell 2008-07-07T16:34:07+00:00 PHP: 5.2.6 OS: Package Version: 1.4.2 Description: ------------ With a source with only @return phpdoc tag + variable type, and XML DocBook converter, the @return tag is not rendered ! Example 1: * @return array In this example, no return bloc rendered Example 2: * @return array or false on error In this example the "array" term is not rendered Expected result: ---------------- Example 1: <refsect1 id="package.php.php-compatinfo.php-compatinfo-parser.getdirlist.returns"> &title.returns; <para> <emphasis>returns</emphasis> array </para> </refsect1> Example 2: <refsect1 id="package.php.php-compatinfo.php-compatinfo-parser.getignoredfiles.returns"> &title.returns; <para> <emphasis>returns</emphasis> array or false on error </para> </refsect1> Actual result: -------------- Example 1: no refsect1 corresponding to &title.returns; was produced Example 2: <refsect1 id="package.php.php-compatinfo.php-compatinfo-parser.getignoredfiles.returns"> &title.returns; <para> <emphasis>returns</emphasis> or false on error </para> </refsect1>]]> 2009-10-12T14:46:51+00:00 pear &#x61;&#116; laurent-laville &#x64;&#111;&#x74; org PhpDocumentor Bug http://pear.php.net/bugs/14244 PhpDocumentor Feature/Change Request Reported by dthomas 2008-06-26T05:25:43+00:00 PHP: 5.2.5 OS: Windows Vista Package Version: 1.4.2 Description: ------------ A warning is outputted if a class doc has no explicit package specified. Since i have always only one class per file the package is already speicified for the file - therefore the implicit usage of that package name for the class is perfect for me. I would like to have an option which suppress the warning of an explicit package vo classes (raised in IntermediateParser.inc line 961).]]> PhpDocumentor Feature/Change Request Reported by dthomas 2008-06-26T05:25:43+00:00 PHP: 5.2.5 OS: Windows Vista Package Version: 1.4.2 Description: ------------ A warning is outputted if a class doc has no explicit package specified. Since i have always only one class per file the package is already speicified for the file - therefore the implicit usage of that package name for the class is perfect for me. I would like to have an option which suppress the warning of an explicit package vo classes (raised in IntermediateParser.inc line 961).]]> 2009-07-21T16:34:17+00:00 third-chance &#x61;&#116; gmx &#x64;&#111;&#x74; de PhpDocumentor Feature/Change Request http://pear.php.net/bugs/14185 PhpDocumentor Feature/Change Request Reported by cybot 2008-06-19T02:13:30+00:00 PHP: Irrelevant OS: Package Version: CVS Description: ------------ functions automatically called by PHP if defined/registered Test script: --------------- tags like: @error_handler @shut_down_function @register_tick_function or @handler error_handler or @registered error_handler or @auto for functions registered with: register_tick_function, register_shutdown_function, spl_autoload_register, set_error_handler, session_set_save_handler]]> PhpDocumentor Feature/Change Request Reported by cybot 2008-06-19T02:13:30+00:00 PHP: Irrelevant OS: Package Version: CVS Description: ------------ functions automatically called by PHP if defined/registered Test script: --------------- tags like: @error_handler @shut_down_function @register_tick_function or @handler error_handler or @registered error_handler or @auto for functions registered with: register_tick_function, register_shutdown_function, spl_autoload_register, set_error_handler, session_set_save_handler]]> 2008-06-19T02:13:30+00:00 pear &#x61;&#116; sebastianmendel &#x64;&#111;&#x74; de PhpDocumentor Feature/Change Request http://pear.php.net/bugs/14184 PhpDocumentor Feature/Change Request Reported by cybot 2008-06-19T02:03:46+00:00 PHP: Irrelevant OS: Package Version: CVS Description: ------------ add a tag to docuemnt script termination in a function Test script: --------------- /** * @exit */ function myExit() { doSomeCleanup(); exit; } /** * @exit if checkSomething() succeeds */ function myCheck() { if (checkSomething()) { exit; } }]]> PhpDocumentor Feature/Change Request Reported by cybot 2008-06-19T02:03:46+00:00 PHP: Irrelevant OS: Package Version: CVS Description: ------------ add a tag to docuemnt script termination in a function Test script: --------------- /** * @exit */ function myExit() { doSomeCleanup(); exit; } /** * @exit if checkSomething() succeeds */ function myCheck() { if (checkSomething()) { exit; } }]]> 2008-06-19T02:03:46+00:00 pear &#x61;&#116; sebastianmendel &#x64;&#111;&#x74; de PhpDocumentor Feature/Change Request http://pear.php.net/bugs/13745 PhpDocumentor Feature/Change Request Reported by ashnazg 2008-04-22T10:55:25+00:00 PHP: 5.2.5 OS: FreeBSD Package Version: 1.4.2 Description: ------------ The code in Setup.inc.php and common.inc.php that decides whether or not the tokenizer is loaded and available failed to spot that a bad tokenizer library upgrade was not functioning properly, leaving the user with no idea why PhpDocumentor wasn't parsing his code [1]. Since the tokenizer_test.php file IS capable of recognizing the problem, see if we can improve the tokenizer checking code in Setup to recognize it and give the user some notice that the tokenizer doesn't appear to be working... also maybe then allow it to default to the old Parser and continue running. [1] - https://sourceforge.net/forum/message.php?msg_id=4914689]]> PhpDocumentor Feature/Change Request Reported by ashnazg 2008-04-22T10:55:25+00:00 PHP: 5.2.5 OS: FreeBSD Package Version: 1.4.2 Description: ------------ The code in Setup.inc.php and common.inc.php that decides whether or not the tokenizer is loaded and available failed to spot that a bad tokenizer library upgrade was not functioning properly, leaving the user with no idea why PhpDocumentor wasn't parsing his code [1]. Since the tokenizer_test.php file IS capable of recognizing the problem, see if we can improve the tokenizer checking code in Setup to recognize it and give the user some notice that the tokenizer doesn't appear to be working... also maybe then allow it to default to the old Parser and continue running. [1] - https://sourceforge.net/forum/message.php?msg_id=4914689]]> 2009-07-21T16:39:54+00:00 demon &#x64;&#111;&#x74; gene &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/13744 PhpDocumentor Feature/Change Request Reported by str238 2008-04-22T09:49:08+00:00 PHP: 5.2.4 OS: WinXP Package Version: 1.4.2 Description: ------------ <? class main_class { /** * trying to link the subclass constant called foo * @see subclass::foo * * or * * @see subclass::$foo * * ... both of them results in plain text when processed */ public function parent_method(){ echo "NO WAY :((("; } } class subclass extends main_class { /** * @see parent_method() */ const foo = 9; } ?>]]> PhpDocumentor Feature/Change Request Reported by str238 2008-04-22T09:49:08+00:00 PHP: 5.2.4 OS: WinXP Package Version: 1.4.2 Description: ------------ <? class main_class { /** * trying to link the subclass constant called foo * @see subclass::foo * * or * * @see subclass::$foo * * ... both of them results in plain text when processed */ public function parent_method(){ echo "NO WAY :((("; } } class subclass extends main_class { /** * @see parent_method() */ const foo = 9; } ?>]]> 2008-05-17T04:40:09+00:00 josef &#x64;&#111;&#x74; stromsky &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/13351 PhpDocumentor Feature/Change Request Reported by hanno 2008-03-08T21:40:29+00:00 PHP: 5.2.5 OS: Package Version: 1.4.1 Description: ------------ I'm not sure if PhpDocumentor is affected, but lately smarty had security issues which were fixed in 2.6.19 (CVE-2008-1066). The bundled smarty code should be updated.]]> PhpDocumentor Feature/Change Request Reported by hanno 2008-03-08T21:40:29+00:00 PHP: 5.2.5 OS: Package Version: 1.4.1 Description: ------------ I'm not sure if PhpDocumentor is affected, but lately smarty had security issues which were fixed in 2.6.19 (CVE-2008-1066). The bundled smarty code should be updated.]]> 2008-05-14T08:04:10+00:00 hanno &#x61;&#116; hboeck &#x64;&#111;&#x74; de PhpDocumentor Feature/Change Request http://pear.php.net/bugs/12733 PhpDocumentor Bug Reported by rudis 2007-12-19T16:59:12+00:00 PHP: 5.2.5 OS: Mac OS X 10.4 Package Version: 1.4.1 Description: ------------ Hi, I'm using PhpDocumentor with XML:DocBook:peardoc2 with the following option: --output XML:DocBook/peardoc2:default The problem is that the errors.html file contains the following errors: Warning: Smarty error: unable to read resource: "header.tpl" in /Library/WebServer/Documents/util/phpdocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php on line 1144 Warning: Smarty error: unable to read resource: "footer.tpl" in /Library/WebServer/Documents/util/phpdocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php on line 1144 This happens because the "header.tpl" and "footer.tpl" files don't exist in phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/. To fix it they have to be added and then everything works fine. Maybe errors.xml should be generated instead of errors.html with valid XML code in it which can be easily parsed. Thanks, Simon]]> PhpDocumentor Bug Reported by rudis 2007-12-19T16:59:12+00:00 PHP: 5.2.5 OS: Mac OS X 10.4 Package Version: 1.4.1 Description: ------------ Hi, I'm using PhpDocumentor with XML:DocBook:peardoc2 with the following option: --output XML:DocBook/peardoc2:default The problem is that the errors.html file contains the following errors: Warning: Smarty error: unable to read resource: "header.tpl" in /Library/WebServer/Documents/util/phpdocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php on line 1144 Warning: Smarty error: unable to read resource: "footer.tpl" in /Library/WebServer/Documents/util/phpdocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php on line 1144 This happens because the "header.tpl" and "footer.tpl" files don't exist in phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/. To fix it they have to be added and then everything works fine. Maybe errors.xml should be generated instead of errors.html with valid XML code in it which can be easily parsed. Thanks, Simon]]> 2009-10-12T15:19:24+00:00 simon &#x61;&#116; ruderich &#x64;&#111;&#x74; com PhpDocumentor Bug http://pear.php.net/bugs/12577 PhpDocumentor Bug Reported by jakubmoc 2007-12-02T14:50:11+00:00 PHP: Irrelevant OS: Irrelevant Package Version: 1.4.0 Description: ------------ package.xml states that this is licensed under LGPL, but - scripts/add_cvs.php and scripts/create_examples.php is licensed under PHP license version 3.0 - PHPDocumentor/Converters/XML/DocBook/XMLDocBookConverter.inc is licensed under PHP license version 3.0 - PHPDocumentor/Converters/XML/DocBook/Plain.php is licensed under PHP license 2.02 - phpDocumentor/Converters/PDF/default/class.ezpdf.php is released as public-domain - phpDocumentor/Converters/PDF/default/templates/fonts misses any license info, and these fonts are pretty unlikely to be LGPL-ed, as they are copyrighted by Adobe Inc. - docbuilder/includes/tabpane.js licensing is unclear, could be Apache Software License 2.0 now but you should check with the author, see http://webfx.eae.net/license.html - bundled HTML_TreeMenu-1.1.2 is clearly licensed under 3-clause BSD license There might be stuff that I didn't catch... What a mess :(]]> PhpDocumentor Bug Reported by jakubmoc 2007-12-02T14:50:11+00:00 PHP: Irrelevant OS: Irrelevant Package Version: 1.4.0 Description: ------------ package.xml states that this is licensed under LGPL, but - scripts/add_cvs.php and scripts/create_examples.php is licensed under PHP license version 3.0 - PHPDocumentor/Converters/XML/DocBook/XMLDocBookConverter.inc is licensed under PHP license version 3.0 - PHPDocumentor/Converters/XML/DocBook/Plain.php is licensed under PHP license 2.02 - phpDocumentor/Converters/PDF/default/class.ezpdf.php is released as public-domain - phpDocumentor/Converters/PDF/default/templates/fonts misses any license info, and these fonts are pretty unlikely to be LGPL-ed, as they are copyrighted by Adobe Inc. - docbuilder/includes/tabpane.js licensing is unclear, could be Apache Software License 2.0 now but you should check with the author, see http://webfx.eae.net/license.html - bundled HTML_TreeMenu-1.1.2 is clearly licensed under 3-clause BSD license There might be stuff that I didn't catch... What a mess :(]]> 2009-10-12T15:20:54+00:00 jakub &#x61;&#116; gentoo &#x64;&#111;&#x74; org PhpDocumentor Bug http://pear.php.net/bugs/12536 PhpDocumentor Feature/Change Request Reported by lsolesen 2007-11-27T06:21:34+00:00 PHP: 5.2.4 OS: Package Version: 1.4.0 Description: ------------ If the errors.html is xml compliant it could for instance be used with phpUnderControl to do some metrics. I would be really easy to change on the current errors.html template.]]> PhpDocumentor Feature/Change Request Reported by lsolesen 2007-11-27T06:21:34+00:00 PHP: 5.2.4 OS: Package Version: 1.4.0 Description: ------------ If the errors.html is xml compliant it could for instance be used with phpUnderControl to do some metrics. I would be really easy to change on the current errors.html template.]]> 2007-12-09T22:46:09+00:00 lars &#x61;&#116; legestue &#x64;&#111;&#x74; net PhpDocumentor Feature/Change Request http://pear.php.net/bugs/12360 PhpDocumentor Bug Reported by cwiedmann 2007-10-30T12:44:52+00:00 PHP: 5.2.4 OS: Windows_NT Package Version: 1.4.0 Description: ------------ Hello, if I use an array as value for a key in a var array, there is something wrong with the rendering. Regards, Carsten Test script: --------------- <?php /** * @package Test */ /** * Description * * @package Test */ class Test { /** * _foo * @var array * @access private */ var $_foo = array( 'Value1' => false, 'Value2' => array(1, 2), 'Value3' => true ); } ?> Expected result: ---------------- array $_foo = array( 'Value1' => false, 'Value2' => array(1, 2), 'Value3' => true) (line 18) Actual result: -------------- array $_foo = array( 'Value1' => false, 'Value2' => array(1, 2),'Value3'=>true) (line 18)]]> PhpDocumentor Bug Reported by cwiedmann 2007-10-30T12:44:52+00:00 PHP: 5.2.4 OS: Windows_NT Package Version: 1.4.0 Description: ------------ Hello, if I use an array as value for a key in a var array, there is something wrong with the rendering. Regards, Carsten Test script: --------------- <?php /** * @package Test */ /** * Description * * @package Test */ class Test { /** * _foo * @var array * @access private */ var $_foo = array( 'Value1' => false, 'Value2' => array(1, 2), 'Value3' => true ); } ?> Expected result: ---------------- array $_foo = array( 'Value1' => false, 'Value2' => array(1, 2), 'Value3' => true) (line 18) Actual result: -------------- array $_foo = array( 'Value1' => false, 'Value2' => array(1, 2),'Value3'=>true) (line 18)]]> 2009-10-12T12:50:33+00:00 carsten_sttgt &#x61;&#116; gmx &#x64;&#111;&#x74; de PhpDocumentor Bug http://pear.php.net/bugs/12236 PhpDocumentor Feature/Change Request Reported by yunosh 2007-10-12T16:38:41+00:00 PHP: Irrelevant OS: Package Version: 1.4.0 Description: ------------ The attached patch allows to parse and include RIC files from any directory. The -ric parameter still takes a list of file (base) names, but all files in all parsed directories that match the name are included. To distinguish files with the same name in different directories, the subdirectory relative to the base directory is prefixed. The patch was only tested on Linux but should work on Windows too. The patch is unobtrusive, i.e. it doesn't change anything for existing projects that have all their RIC files in the base directory. Thus I would appreciate if it could be applied for 1.4.1 and doesn't have to wait for 1.5.0.]]> PhpDocumentor Feature/Change Request Reported by yunosh 2007-10-12T16:38:41+00:00 PHP: Irrelevant OS: Package Version: 1.4.0 Description: ------------ The attached patch allows to parse and include RIC files from any directory. The -ric parameter still takes a list of file (base) names, but all files in all parsed directories that match the name are included. To distinguish files with the same name in different directories, the subdirectory relative to the base directory is prefixed. The patch was only tested on Linux but should work on Windows too. The patch is unobtrusive, i.e. it doesn't change anything for existing projects that have all their RIC files in the base directory. Thus I would appreciate if it could be applied for 1.4.1 and doesn't have to wait for 1.5.0.]]> 2007-12-09T10:51:58+00:00 jan &#x61;&#116; horde &#x64;&#111;&#x74; org PhpDocumentor Feature/Change Request http://pear.php.net/bugs/12234 PhpDocumentor Feature/Change Request Reported by cweiske 2007-10-12T12:54:48+00:00 PHP: Irrelevant OS: Package Version: 1.4.0 Description: ------------ It would be nice if values like NULL, TRUE and FALSE would get highlighted and made italic/bold in html. One idea is to use inline tags like {@true}, {@false} and @{null}.]]> PhpDocumentor Feature/Change Request Reported by cweiske 2007-10-12T12:54:48+00:00 PHP: Irrelevant OS: Package Version: 1.4.0 Description: ------------ It would be nice if values like NULL, TRUE and FALSE would get highlighted and made italic/bold in html. One idea is to use inline tags like {@true}, {@false} and @{null}.]]> 2007-11-12T20:45:17+00:00 cweiske &#x61;&#116; php &#x64;&#111;&#x74; net PhpDocumentor Feature/Change Request http://pear.php.net/bugs/12199 PhpDocumentor Feature/Change Request Reported by cweiske 2007-10-08T07:54:05+00:00 PHP: 5.2.4 OS: Package Version: 1.4.0 Description: ------------ it would be helpful if @return would allow specifying the type of array values, e.g. @return array(MyClass) Array of MyClass objects]]> PhpDocumentor Feature/Change Request Reported by cweiske 2007-10-08T07:54:05+00:00 PHP: 5.2.4 OS: Package Version: 1.4.0 Description: ------------ it would be helpful if @return would allow specifying the type of array values, e.g. @return array(MyClass) Array of MyClass objects]]> 2008-04-11T11:22:41+00:00 cweiske &#x61;&#116; php &#x64;&#111;&#x74; net PhpDocumentor Feature/Change Request http://pear.php.net/bugs/12128 PhpDocumentor Feature/Change Request Reported by lampacz 2007-09-27T08:06:06+00:00 PHP: 5.2.4 OS: Linux / Debian unstable Package Version: 1.4.0 Description: ------------ add command line ? option to specify encoding for html output: something like: <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> replace to: <meta http-equiv='Content-Type' content='text/html; charset={$encoding}'/> Expected result: ---------------- non iso-8859-1 character (national characters) will be show OK (browser select right encoding, now i must select it manualy - override html header) Actual result: -------------- bad displaying non iso-8859-1 characters (national characters missing in iso-8859-1)]]> PhpDocumentor Feature/Change Request Reported by lampacz 2007-09-27T08:06:06+00:00 PHP: 5.2.4 OS: Linux / Debian unstable Package Version: 1.4.0 Description: ------------ add command line ? option to specify encoding for html output: something like: <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> replace to: <meta http-equiv='Content-Type' content='text/html; charset={$encoding}'/> Expected result: ---------------- non iso-8859-1 character (national characters) will be show OK (browser select right encoding, now i must select it manualy - override html header) Actual result: -------------- bad displaying non iso-8859-1 characters (national characters missing in iso-8859-1)]]> 2007-11-12T20:43:15+00:00 lampacz &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/12100 PhpDocumentor Feature/Change Request Reported by seann 2007-09-23T10:48:09+00:00 PHP: 4.4.6 OS: Windows XP Package Version: 1.4.0 Description: ------------ Hello, Got a small problem. Let's say I have three classes: "Car", "Jaguar" and "Dealer". "Car" is the superclass of "Jaguar" and the "Dealer" uses the method "setPrice()" of the "Jaguar" class; this method is inherited from its superclass "Car". So, currently I'm referring to this method, when documenting the "Dealer" class, as "@uses Jaguar::setPrice()". The problem is that PhpDocumentor will NOT create a link to this method, which should point to the "setPrice()" method in the "Car" class. Please note that the "setPrice()" method IS documented for the "Jaguar" class by PhpDocumentor as an inherited method from the "Car" class. Anybody has some ideas on how to solve this? Referring directly to the method "setPrice()" in the "Car" class ("@uses Car::setPrice()") would be a little bit strange, since the Dealer is only aware of the existence of the "Jaguar" class. Thanks in advance.]]> PhpDocumentor Feature/Change Request Reported by seann 2007-09-23T10:48:09+00:00 PHP: 4.4.6 OS: Windows XP Package Version: 1.4.0 Description: ------------ Hello, Got a small problem. Let's say I have three classes: "Car", "Jaguar" and "Dealer". "Car" is the superclass of "Jaguar" and the "Dealer" uses the method "setPrice()" of the "Jaguar" class; this method is inherited from its superclass "Car". So, currently I'm referring to this method, when documenting the "Dealer" class, as "@uses Jaguar::setPrice()". The problem is that PhpDocumentor will NOT create a link to this method, which should point to the "setPrice()" method in the "Car" class. Please note that the "setPrice()" method IS documented for the "Jaguar" class by PhpDocumentor as an inherited method from the "Car" class. Anybody has some ideas on how to solve this? Referring directly to the method "setPrice()" in the "Car" class ("@uses Car::setPrice()") would be a little bit strange, since the Dealer is only aware of the existence of the "Jaguar" class. Thanks in advance.]]> 2009-10-12T14:16:09+00:00 sean &#x61;&#116; natoewal &#x64;&#111;&#x74; nl PhpDocumentor Feature/Change Request http://pear.php.net/bugs/11943 PhpDocumentor Feature/Change Request Reported by ashnazg 2007-08-30T11:42:30+00:00 PHP: 5.2.3 OS: Irrelevant Package Version: 1.4.0 Description: ------------ (From Sebastian Bergmann on phpdocu-developer@lists.sourceforge.net) PHPUnit's skeleton generator supports generating tests from @assert annotations <?php class Calculator { /** * @assert (1, 1) == 2 */ public function add($a, $b) { return $a + $b; } } ?> Each method in the original class is checked for @assert annotations. These are transformed into test code such as /** * Generated from @assert (1, 1) == 2. */ public function testAdd() { $o = new Calculator; $this->assertEquals(2, $o->add(1, 1)); } What does this have to do with PHPDocumentor? Well, would it not be nice if PHPDocumentor understood the @assert annotation and automatically generated usage examples of the annotated method in its documentation? This could, for instance look like <?php $o = new Calculator; print $o->add(1, 1); ?> 2]]> PhpDocumentor Feature/Change Request Reported by ashnazg 2007-08-30T11:42:30+00:00 PHP: 5.2.3 OS: Irrelevant Package Version: 1.4.0 Description: ------------ (From Sebastian Bergmann on phpdocu-developer@lists.sourceforge.net) PHPUnit's skeleton generator supports generating tests from @assert annotations <?php class Calculator { /** * @assert (1, 1) == 2 */ public function add($a, $b) { return $a + $b; } } ?> Each method in the original class is checked for @assert annotations. These are transformed into test code such as /** * Generated from @assert (1, 1) == 2. */ public function testAdd() { $o = new Calculator; $this->assertEquals(2, $o->add(1, 1)); } What does this have to do with PHPDocumentor? Well, would it not be nice if PHPDocumentor understood the @assert annotation and automatically generated usage examples of the annotated method in its documentation? This could, for instance look like <?php $o = new Calculator; print $o->add(1, 1); ?> 2]]> 2007-11-12T20:41:13+00:00 demon &#x64;&#111;&#x74; gene &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/11847 PhpDocumentor Feature/Change Request Reported by ashnazg 2007-08-15T13:22:18+00:00 PHP: 5.2.3 OS: Irrelevant Package Version: 1.4.0 Description: ------------ Add into PhpDocumentor the output converter template used by pearweb for package API doc generation. Call it HTML:Smarty:pearweb. cellog has already provided me with the files.]]> PhpDocumentor Feature/Change Request Reported by ashnazg 2007-08-15T13:22:18+00:00 PHP: 5.2.3 OS: Irrelevant Package Version: 1.4.0 Description: ------------ Add into PhpDocumentor the output converter template used by pearweb for package API doc generation. Call it HTML:Smarty:pearweb. cellog has already provided me with the files.]]> 2007-09-14T10:22:31+00:00 demon &#x64;&#111;&#x74; gene &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/11833 PhpDocumentor Feature/Change Request Reported by ashnazg 2007-08-13T13:13:53+00:00 PHP: 5.2.3 OS: Irrelevant Package Version: 1.4.0 Description: ------------ Using a config file currently means any other runtime commandline args are ignored. Better flexibility can be achieved by allowing a config file AND commandline runtime args to be used. In the case of any config file options that are also specified in the command-line, it should be assumed that the user wants to OVERRIDE the config file's value with the command-line value... otherwise, the user would not have specified it on the command-line, knowing it was already in the config file. This added flexibility can allow different code projects to set only certain runtime args in their own config files, while still allowing other runtime args to be specified on the command-line at runtime.]]> PhpDocumentor Feature/Change Request Reported by ashnazg 2007-08-13T13:13:53+00:00 PHP: 5.2.3 OS: Irrelevant Package Version: 1.4.0 Description: ------------ Using a config file currently means any other runtime commandline args are ignored. Better flexibility can be achieved by allowing a config file AND commandline runtime args to be used. In the case of any config file options that are also specified in the command-line, it should be assumed that the user wants to OVERRIDE the config file's value with the command-line value... otherwise, the user would not have specified it on the command-line, knowing it was already in the config file. This added flexibility can allow different code projects to set only certain runtime args in their own config files, while still allowing other runtime args to be specified on the command-line at runtime.]]> 2007-08-13T13:13:53+00:00 demon &#x64;&#111;&#x74; gene &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/11799 PhpDocumentor Feature/Change Request Reported by peternagy 2007-08-08T14:43:25+00:00 PHP: Irrelevant OS: Irrelevant Package Version: 1.4.0 Description: ------------ At the moment I don't know any solution to check a configuration file against errors. Test script: --------------- phpdoc --dryrun on --useconfig /home/user/workspace/foo/phpdoc.ini Expected result: ---------------- Error at line 12 in /home/user/workspace/foo/phpdoc.ini]]> PhpDocumentor Feature/Change Request Reported by peternagy 2007-08-08T14:43:25+00:00 PHP: Irrelevant OS: Irrelevant Package Version: 1.4.0 Description: ------------ At the moment I don't know any solution to check a configuration file against errors. Test script: --------------- phpdoc --dryrun on --useconfig /home/user/workspace/foo/phpdoc.ini Expected result: ---------------- Error at line 12 in /home/user/workspace/foo/phpdoc.ini]]> 2007-11-12T20:40:28+00:00 antronin &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/11794 PhpDocumentor Feature/Change Request Reported by peternagy 2007-08-08T09:14:36+00:00 PHP: Irrelevant OS: Irrelevant Package Version: 1.4.0 Description: ------------ Just realized that when using -c or --useconfig switch, phpdoc searches the config file in PEAR/data/PhpDocumentor/user directory (in Windows). This means I cannot keep my config for docgeneration together with my project files and folders (for example to send it to SVN/CVS). I think it would be a great enchantment to load a config file from anywhere with a full path (and default could stay the user folder in PEAR).]]> PhpDocumentor Feature/Change Request Reported by peternagy 2007-08-08T09:14:36+00:00 PHP: Irrelevant OS: Irrelevant Package Version: 1.4.0 Description: ------------ Just realized that when using -c or --useconfig switch, phpdoc searches the config file in PEAR/data/PhpDocumentor/user directory (in Windows). This means I cannot keep my config for docgeneration together with my project files and folders (for example to send it to SVN/CVS). I think it would be a great enchantment to load a config file from anywhere with a full path (and default could stay the user folder in PEAR).]]> 2007-08-08T14:52:05+00:00 antronin &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/11618 PhpDocumentor Feature/Change Request Reported by ashnazg 2007-07-16T16:02:22+00:00 PHP: 5.2.3 OS: irrelevant Package Version: 1.4.0RC2 Description: ------------ When the element listed in a @uses tag is a private element, and the --parseprivate flag is set OFF, then the USES tag gets displayed showing the name of the private member, though obviously it does not link to that element's docs (since there was no doc created for that element). In this scenario, I'd prefer the USES tag completely suppress itself, since it cannot point me to any other useful doc (its element is not documented), but mostly because it's telling my users about an element I didn't want them to see (-pp off). Test script: --------------- <?php /** * test file for enhancement * @package BugReports */ /** * class A */ class A { /** * @var int * @access private */ private $privateVar = 0; /** * @access public * @uses $privateVar */ public publicMethod() { return $this->privateVar; } } ?> Expected result: ---------------- Class A Description * access: public Located in /newbug.php (line 9) Actual result: -------------- Class A Description * access: public * uses: $privateVar Located in /newbug.php (line 9)]]> PhpDocumentor Feature/Change Request Reported by ashnazg 2007-07-16T16:02:22+00:00 PHP: 5.2.3 OS: irrelevant Package Version: 1.4.0RC2 Description: ------------ When the element listed in a @uses tag is a private element, and the --parseprivate flag is set OFF, then the USES tag gets displayed showing the name of the private member, though obviously it does not link to that element's docs (since there was no doc created for that element). In this scenario, I'd prefer the USES tag completely suppress itself, since it cannot point me to any other useful doc (its element is not documented), but mostly because it's telling my users about an element I didn't want them to see (-pp off). Test script: --------------- <?php /** * test file for enhancement * @package BugReports */ /** * class A */ class A { /** * @var int * @access private */ private $privateVar = 0; /** * @access public * @uses $privateVar */ public publicMethod() { return $this->privateVar; } } ?> Expected result: ---------------- Class A Description * access: public Located in /newbug.php (line 9) Actual result: -------------- Class A Description * access: public * uses: $privateVar Located in /newbug.php (line 9)]]> 2007-11-12T20:39:35+00:00 demon &#x64;&#111;&#x74; gene &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/11540 PhpDocumentor Bug Reported by farell 2007-07-06T02:52:15+00:00 PHP: 5.2.3 OS: Windows XP Package Version: 1.4.0RC1 Description: ------------ While trying to generate XML DocBook pages for PEAR_Info, I've noticed that @static tag is not well renders. Using phpdoc command line on a Windows XP dosbox See file content: language-snippets.ent http://cvs.php.net/viewvc.cgi/peardoc/en/language-snippets.ent?revision=1.15&view=markup ---------------- <!ENTITY note.shouldstatic '<simpara>This function should be called statically.</simpara>'> <!ENTITY note.notstatic '<simpara>This function can not be called statically.</simpara>'> ---------------- Test script: --------------- phpdoc -c pear_info.ini With C:\wamp\php\PEAR\data\PhpDocumentor\user\pear_info.ini content (comment stripped tags) [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 Expected result: ---------------- <refsect1 id="package.pear.pear-info.pear-info.setproxy.note"> &title.note; &note.shouldstatic; </refsect1> Actual result: -------------- <refsect1 id="package.pear.pear-info.pear-info.setproxy.note"> &title.note; &note.notstatic; </refsect1>]]> PhpDocumentor Bug Reported by farell 2007-07-06T02:52:15+00:00 PHP: 5.2.3 OS: Windows XP Package Version: 1.4.0RC1 Description: ------------ While trying to generate XML DocBook pages for PEAR_Info, I've noticed that @static tag is not well renders. Using phpdoc command line on a Windows XP dosbox See file content: language-snippets.ent http://cvs.php.net/viewvc.cgi/peardoc/en/language-snippets.ent?revision=1.15&view=markup ---------------- <!ENTITY note.shouldstatic '<simpara>This function should be called statically.</simpara>'> <!ENTITY note.notstatic '<simpara>This function can not be called statically.</simpara>'> ---------------- Test script: --------------- phpdoc -c pear_info.ini With C:\wamp\php\PEAR\data\PhpDocumentor\user\pear_info.ini content (comment stripped tags) [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 Expected result: ---------------- <refsect1 id="package.pear.pear-info.pear-info.setproxy.note"> &title.note; &note.shouldstatic; </refsect1> Actual result: -------------- <refsect1 id="package.pear.pear-info.pear-info.setproxy.note"> &title.note; &note.notstatic; </refsect1>]]> 2008-03-25T21:55:27+00:00 pear &#x61;&#116; laurent-laville &#x64;&#111;&#x74; org PhpDocumentor Bug http://pear.php.net/bugs/11503 PhpDocumentor Feature/Change Request Reported by cybot 2007-07-02T05:22:42+00:00 PHP: Irrelevant OS: Package Version: CVS Description: ------------ add an tag to docuemnt output with echo/print or with other classes @out or @stdout with type of output @out xml @out html @out binary @out image/jpeg with method of output @out html Smarty or @out html Smarty::display() @out text echo or @out html php]]> PhpDocumentor Feature/Change Request Reported by cybot 2007-07-02T05:22:42+00:00 PHP: Irrelevant OS: Package Version: CVS Description: ------------ add an tag to docuemnt output with echo/print or with other classes @out or @stdout with type of output @out xml @out html @out binary @out image/jpeg with method of output @out html Smarty or @out html Smarty::display() @out text echo or @out html php]]> 2007-07-02T05:22:42+00:00 pear &#x61;&#116; sebastianmendel &#x64;&#111;&#x74; de PhpDocumentor Feature/Change Request http://pear.php.net/bugs/11137 PhpDocumentor Feature/Change Request Reported by cybot 2007-05-25T02:57:36+00:00 PHP: Irrelevant OS: Package Version: 1.3.2 Description: ------------ it is different if a method is called statically or in object context, it would be nice if i could document this: @uses Parent::getId() @uses $this->getId() ... $id_to = Parent::getId($some_unique_criteria); $id_from = $this->getId(); ... 1. it is a difference if a function is called statically or not 2. $this->getId() should point to the class and method where this method is defined currently you have to take care where a method is defined, for example class A {function a(){}} class B extends A {} class C extends B { /** * @uses A::a() */ function c(){ $this->a(); } } if for some reason the method a() is redefined in class B i have to rewrite my whole documentation for class C (or ALL classes extending from B) so @uses $this->getId() should point to the correct method in the generated documentation ...]]> PhpDocumentor Feature/Change Request Reported by cybot 2007-05-25T02:57:36+00:00 PHP: Irrelevant OS: Package Version: 1.3.2 Description: ------------ it is different if a method is called statically or in object context, it would be nice if i could document this: @uses Parent::getId() @uses $this->getId() ... $id_to = Parent::getId($some_unique_criteria); $id_from = $this->getId(); ... 1. it is a difference if a function is called statically or not 2. $this->getId() should point to the class and method where this method is defined currently you have to take care where a method is defined, for example class A {function a(){}} class B extends A {} class C extends B { /** * @uses A::a() */ function c(){ $this->a(); } } if for some reason the method a() is redefined in class B i have to rewrite my whole documentation for class C (or ALL classes extending from B) so @uses $this->getId() should point to the correct method in the generated documentation ...]]> 2007-11-12T20:37:43+00:00 pear &#x61;&#116; sebastianmendel &#x64;&#111;&#x74; de PhpDocumentor Feature/Change Request http://pear.php.net/bugs/11136 PhpDocumentor Feature/Change Request Reported by cybot 2007-05-25T02:44:20+00:00 PHP: Irrelevant OS: Package Version: 1.3.2 Description: ------------ @return should accept functions/methods/propertys if function/method returns the return from another function/method i would like to document this current: @uses function() as return value @return string result from function() but it would be better to use @return function() @return function() at first i could save one doc-tag (@uses) and second the return value of function() could be changed and doesn't needs to be documented twice or even more if used often ...]]> PhpDocumentor Feature/Change Request Reported by cybot 2007-05-25T02:44:20+00:00 PHP: Irrelevant OS: Package Version: 1.3.2 Description: ------------ @return should accept functions/methods/propertys if function/method returns the return from another function/method i would like to document this current: @uses function() as return value @return string result from function() but it would be better to use @return function() @return function() at first i could save one doc-tag (@uses) and second the return value of function() could be changed and doesn't needs to be documented twice or even more if used often ...]]> 2007-11-12T20:36:33+00:00 pear &#x61;&#116; sebastianmendel &#x64;&#111;&#x74; de PhpDocumentor Feature/Change Request http://pear.php.net/bugs/10996 PhpDocumentor Feature/Change Request Reported by ashnazg 2007-05-09T14:50:07+00:00 PHP: Irrelevant OS: Irrelevant Package Version: 1.4.0a1 Description: ------------ Would an @tests tag (the verb "tests", not the plural noun "tests") be useful for tying a unit test to the classes/methods it covers? I'm thinking of using them in the unit test docblocks themselves, NOT in the class's docblocks. It would mimic the USES/USEDBY scenario where you put "@tests class::method" in the unit test docblock, and would result in the generated documentation for that class/method to show a "Tested-By: unit-test-class::testMethod" entry. I think I've seen requests before asking for an "@tested" tag for the class/method docblocks, which would require you to hand-maintain them, but this "@tests" alternative would remove that hand-maintainence. As long as you keep your unit-tests's docblocks up-to-date with "@tests" tags, then your classes' documentation would also stay up-to-date with the resulting "@tested-by" entries. Further, since this is something the developer is interested in knowing, not the user, the --parseprivate flag would control whether or not it is included in the generated documentation. A test coverage tool is obviously the more complete way to determine test coverage, but this could be a meager alternative when such a tool is not viable. Test script: --------------- blah.php ======================================================= /** * the BLAH class * @package ashnazg * @author also-ashnazg */ class blah { /** * the blahMe function * @param none * @return bool */ function blahMe() { return true; } } ======================================================= blahTest.php ======================================================= /** * the unit tests * for the BLAH class * @package ashnazg * @subpackage unitTests */ class blahTests { private $blah; /** * test the blahMe function * @tests blah::blahMe */ function testBlahMe() { assertTrue($this->blah->blahMe(), true); } } ======================================================= Expected result: ---------------- Doc for blahMe method ======================================================= blahMe [line 12] boolean blahMe( ) the blahMe function Parameters: none API Tags: Return: bool Tested-By: blahTests::testBlahMe <--- hyperlink ======================================================= Doc for testBlahMe method ======================================================= testBlahMe [line 12] void blahMe( ) the blahMe function API Tags: Tests: blah::blahMe <--- hyperlink =======================================================]]> PhpDocumentor Feature/Change Request Reported by ashnazg 2007-05-09T14:50:07+00:00 PHP: Irrelevant OS: Irrelevant Package Version: 1.4.0a1 Description: ------------ Would an @tests tag (the verb "tests", not the plural noun "tests") be useful for tying a unit test to the classes/methods it covers? I'm thinking of using them in the unit test docblocks themselves, NOT in the class's docblocks. It would mimic the USES/USEDBY scenario where you put "@tests class::method" in the unit test docblock, and would result in the generated documentation for that class/method to show a "Tested-By: unit-test-class::testMethod" entry. I think I've seen requests before asking for an "@tested" tag for the class/method docblocks, which would require you to hand-maintain them, but this "@tests" alternative would remove that hand-maintainence. As long as you keep your unit-tests's docblocks up-to-date with "@tests" tags, then your classes' documentation would also stay up-to-date with the resulting "@tested-by" entries. Further, since this is something the developer is interested in knowing, not the user, the --parseprivate flag would control whether or not it is included in the generated documentation. A test coverage tool is obviously the more complete way to determine test coverage, but this could be a meager alternative when such a tool is not viable. Test script: --------------- blah.php ======================================================= /** * the BLAH class * @package ashnazg * @author also-ashnazg */ class blah { /** * the blahMe function * @param none * @return bool */ function blahMe() { return true; } } ======================================================= blahTest.php ======================================================= /** * the unit tests * for the BLAH class * @package ashnazg * @subpackage unitTests */ class blahTests { private $blah; /** * test the blahMe function * @tests blah::blahMe */ function testBlahMe() { assertTrue($this->blah->blahMe(), true); } } ======================================================= Expected result: ---------------- Doc for blahMe method ======================================================= blahMe [line 12] boolean blahMe( ) the blahMe function Parameters: none API Tags: Return: bool Tested-By: blahTests::testBlahMe <--- hyperlink ======================================================= Doc for testBlahMe method ======================================================= testBlahMe [line 12] void blahMe( ) the blahMe function API Tags: Tests: blah::blahMe <--- hyperlink =======================================================]]> 2007-11-12T20:35:49+00:00 demon &#x64;&#111;&#x74; gene &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/10750 PhpDocumentor Feature/Change Request Reported by ashnazg 2007-04-16T17:16:31+00:00 PHP: 5.1.6 OS: WinXP Package Version: 1.3.2 Description: ------------ The sorting of USES and USEDBY tags in the generated docs seems neither alphabetical nor object-based, nor even "in the order they appear" in the docblock. I'd prefer it at least be alphabetical overall, or better to be sorted object-based alphabetically. Test script: --------------- /** * Function blah() * @param mixed $x * @param mixed $y * @uses bigDummy * @uses _a * @uses _b * @uses bigMummy */ function blah($x, $y) { $_a = $x; $_b = $y; $dad = new bigDummy(); $mom = new bigMummy(); } Expected result: ---------------- Uses: bigDummy Uses: bigMummy Uses: blah::$_a Uses: blah::$_b Actual result: -------------- Uses: blah::$_b Uses: blah::$_a Uses: bigMummy Uses: bigDummy]]> PhpDocumentor Feature/Change Request Reported by ashnazg 2007-04-16T17:16:31+00:00 PHP: 5.1.6 OS: WinXP Package Version: 1.3.2 Description: ------------ The sorting of USES and USEDBY tags in the generated docs seems neither alphabetical nor object-based, nor even "in the order they appear" in the docblock. I'd prefer it at least be alphabetical overall, or better to be sorted object-based alphabetically. Test script: --------------- /** * Function blah() * @param mixed $x * @param mixed $y * @uses bigDummy * @uses _a * @uses _b * @uses bigMummy */ function blah($x, $y) { $_a = $x; $_b = $y; $dad = new bigDummy(); $mom = new bigMummy(); } Expected result: ---------------- Uses: bigDummy Uses: bigMummy Uses: blah::$_a Uses: blah::$_b Actual result: -------------- Uses: blah::$_b Uses: blah::$_a Uses: bigMummy Uses: bigDummy]]> 2007-04-27T08:34:35+00:00 demon &#x64;&#111;&#x74; gene &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/10640 PhpDocumentor Feature/Change Request Reported by cellog 2007-04-06T12:37:12+00:00 PHP: Irrelevant OS: n/a Package Version: CVS Description: ------------ The entire project can be split into separate packages, so that each converter can be developed separately and even released separately from the main package. Using package.xml, we can still create a get-the-whole-thing-at-once tarball for download from the sourceforge page. This will make it much easier to do modular releases often and early]]> PhpDocumentor Feature/Change Request Reported by cellog 2007-04-06T12:37:12+00:00 PHP: Irrelevant OS: n/a Package Version: CVS Description: ------------ The entire project can be split into separate packages, so that each converter can be developed separately and even released separately from the main package. Using package.xml, we can still create a get-the-whole-thing-at-once tarball for download from the sourceforge page. This will make it much easier to do modular releases often and early]]> 2007-04-24T16:02:35+00:00 greg &#x61;&#116; chiaraquartet &#x64;&#111;&#x74; net PhpDocumentor Feature/Change Request http://pear.php.net/bugs/10588 PhpDocumentor Feature/Change Request Reported by elvanor 2007-04-02T02:52:04+00:00 PHP: 5.2.1 OS: Linux (all) Package Version: 1.3.1 Description: ------------ It would be nice to be able to have an option to remove the line numbers produced in the generated documentation. I am speaking about the line numbers appearing near the methods (to localize them in the source code), these line numbers may appear in other places as well.]]> PhpDocumentor Feature/Change Request Reported by elvanor 2007-04-02T02:52:04+00:00 PHP: 5.2.1 OS: Linux (all) Package Version: 1.3.1 Description: ------------ It would be nice to be able to have an option to remove the line numbers produced in the generated documentation. I am speaking about the line numbers appearing near the methods (to localize them in the source code), these line numbers may appear in other places as well.]]> 2007-04-27T08:35:08+00:00 elvanor2007 &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/10558 PhpDocumentor Bug Reported by ashnazg 2007-03-29T16:05:03+00:00 PHP: 5.1.6 OS: WinXP Package Version: CVS Description: ------------ Using any of the PHP v5 versions (5.1.6, 5.2.0, 5.2.1) I run PhpDocumentor (CVS Head) against, in the sourcecode view of the source file, all subsequent lines of a multiline tag description get an extra leading space. Test script: --------------- <?php /** * Page Directive for BugReport3.php * * @author $Author$ * @version $Name$ * @package BugReports * @todo NEEDS PAGE DIRECTIVE * WRITTEN AND UNDERSTOOD * BUT NOT IMMORTALIZED */ ?> Expected result: ---------------- <?php /** * Page Directive for BugReport3.php * * @author $Author$ * @version $Name$ * @package BugReports * @todo NEEDS PAGE DIRECTIVE * WRITTEN AND UNDERSTOOD * BUT NOT IMMORTALIZED */ ?> Actual result: -------------- <?php /** * Page Directive for BugReport3.php * * @author $Author$ * @version $Name$ * @package BugReports * @todo NEEDS PAGE DIRECTIVE * WRITTEN AND UNDERSTOOD * BUT NOT IMMORTALIZED */ ?>]]> PhpDocumentor Bug Reported by ashnazg 2007-03-29T16:05:03+00:00 PHP: 5.1.6 OS: WinXP Package Version: CVS Description: ------------ Using any of the PHP v5 versions (5.1.6, 5.2.0, 5.2.1) I run PhpDocumentor (CVS Head) against, in the sourcecode view of the source file, all subsequent lines of a multiline tag description get an extra leading space. Test script: --------------- <?php /** * Page Directive for BugReport3.php * * @author $Author$ * @version $Name$ * @package BugReports * @todo NEEDS PAGE DIRECTIVE * WRITTEN AND UNDERSTOOD * BUT NOT IMMORTALIZED */ ?> Expected result: ---------------- <?php /** * Page Directive for BugReport3.php * * @author $Author$ * @version $Name$ * @package BugReports * @todo NEEDS PAGE DIRECTIVE * WRITTEN AND UNDERSTOOD * BUT NOT IMMORTALIZED */ ?> Actual result: -------------- <?php /** * Page Directive for BugReport3.php * * @author $Author$ * @version $Name$ * @package BugReports * @todo NEEDS PAGE DIRECTIVE * WRITTEN AND UNDERSTOOD * BUT NOT IMMORTALIZED */ ?>]]> 2009-10-13T14:13:09+00:00 demon &#x64;&#111;&#x74; gene &#x61;&#116; gmail &#x64;&#111;&#x74; com PhpDocumentor Bug http://pear.php.net/bugs/9129 PhpDocumentor Feature/Change Request Reported by pear@... 2006-10-21T21:09:25+00:00 PHP: 5.1.6 OS: FC5 Package Version: 1.3.0 Description: ------------ I just installed PHPDocumentor 1.3.0RC6 by following the INSTALL instructions. Everything seems to function properly, except when I try to view documentation on individual files. I believe the problem is because the pages being generated are xhtml pages and have the <?xml version="1.0" encoding="iso-8859-1"?> at the beginning of the document. I know this is causing the problem because removing that first line makes the page come up just fine. Even though the page is just html, apache is interpreting it as php because it is called something like _filename.php.html. I think a possible solution would be to rename the file to something like _filename_php.html so that the web server doesn't get confused what file type it is. I tried renaming the files and they load properly, but of course they aren't linked anymore. Turning off short_open_tags in php.ini would also fix this problem, but most of my code uses short_open_tags, so it would break more than it would fix if I changed it. Expected result: ---------------- Pages that don't contain a parse error. Actual result: -------------- Documentation for individual pages produce a parse error. These pages have a filename of the following format: _filename.php.html]]> PhpDocumentor Feature/Change Request Reported by pear@... 2006-10-21T21:09:25+00:00 PHP: 5.1.6 OS: FC5 Package Version: 1.3.0 Description: ------------ I just installed PHPDocumentor 1.3.0RC6 by following the INSTALL instructions. Everything seems to function properly, except when I try to view documentation on individual files. I believe the problem is because the pages being generated are xhtml pages and have the <?xml version="1.0" encoding="iso-8859-1"?> at the beginning of the document. I know this is causing the problem because removing that first line makes the page come up just fine. Even though the page is just html, apache is interpreting it as php because it is called something like _filename.php.html. I think a possible solution would be to rename the file to something like _filename_php.html so that the web server doesn't get confused what file type it is. I tried renaming the files and they load properly, but of course they aren't linked anymore. Turning off short_open_tags in php.ini would also fix this problem, but most of my code uses short_open_tags, so it would break more than it would fix if I changed it. Expected result: ---------------- Pages that don't contain a parse error. Actual result: -------------- Documentation for individual pages produce a parse error. These pages have a filename of the following format: _filename.php.html]]> 2007-11-12T20:34:51+00:00 pear &#x61;&#116; lehi &#x64;&#111;&#x74; ath &#x64;&#111;&#x74; cx PhpDocumentor Feature/Change Request http://pear.php.net/bugs/7563 PhpDocumentor Feature/Change Request Reported by yunosh 2006-05-05T06:52:07+00:00 PHP: 4.3.11 OS: FreeBSD 4.11-STABLE Package Version: 1.3.0RC6 Description: ------------ When generating the API docs for Horde's framework module, we get the following error each time: php in malloc(): warning: recursive call FATAL: emalloc(): Unable to allocate 129 bytes All other modules work fine, and even the API docs seem to be generated correctly. This happened since ever, it's nothing that was introduced with RC6. I justed tested on a Linux system, and there I get a fatal error due to exceeding memory_limit during "Processing Procedural Page Element Name Conflicts": Sorting page elements...done Formatting @uses list...Building indexes... Fatal error: Allowed memory size of 268435456 bytes exhausted at /home/jan/cvs/p hp44/Zend/zend_hash.c:275 (tried to allocate 52 bytes) in /usr/share/php/PhpDocu mentor/phpDocumentor/Converter.inc on line 1474 Call Stack: 0.0003 14736 1. {main}() /usr/bin/phpdoc:0 0.0008 22568 2. include() /usr/bin/phpdoc:37 0.2282 7522336 3. phpdocumentor_setup->createdocs() /usr/share/php/PhpD ocumentor/phpDocumentor/phpdoc.inc:62 517.5416 237710696 4. phpdocumentor_intermediateparser->output() /usr/share /php/PhpDocumentor/phpDocumentor/Setup.inc.php:672 528.7395 251154104 5. phpdocumentor_intermediateparser->_setupuseslist() /u sr/share/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1764 528.7397 251195072 6. __dummyconverter->_createpkgelements() /usr/share/php /PhpDocumentor/phpDocumentor/IntermediateParser.inc:1500 Test script: --------------- The command being used is: phpdoc -d framework -t api -i CVS/\* -o "HTML:frames:phphtmllib" -ti "framework" -dn horde -dc horde --pear The framework module can be checked out from Horde's CVS server (http://horde.org/source/) or downloaded as a snapshot (framework-HEAD-...tar.gz from http://ftp.horde.org/pub/snaps/latest/).]]> PhpDocumentor Feature/Change Request Reported by yunosh 2006-05-05T06:52:07+00:00 PHP: 4.3.11 OS: FreeBSD 4.11-STABLE Package Version: 1.3.0RC6 Description: ------------ When generating the API docs for Horde's framework module, we get the following error each time: php in malloc(): warning: recursive call FATAL: emalloc(): Unable to allocate 129 bytes All other modules work fine, and even the API docs seem to be generated correctly. This happened since ever, it's nothing that was introduced with RC6. I justed tested on a Linux system, and there I get a fatal error due to exceeding memory_limit during "Processing Procedural Page Element Name Conflicts": Sorting page elements...done Formatting @uses list...Building indexes... Fatal error: Allowed memory size of 268435456 bytes exhausted at /home/jan/cvs/p hp44/Zend/zend_hash.c:275 (tried to allocate 52 bytes) in /usr/share/php/PhpDocu mentor/phpDocumentor/Converter.inc on line 1474 Call Stack: 0.0003 14736 1. {main}() /usr/bin/phpdoc:0 0.0008 22568 2. include() /usr/bin/phpdoc:37 0.2282 7522336 3. phpdocumentor_setup->createdocs() /usr/share/php/PhpD ocumentor/phpDocumentor/phpdoc.inc:62 517.5416 237710696 4. phpdocumentor_intermediateparser->output() /usr/share /php/PhpDocumentor/phpDocumentor/Setup.inc.php:672 528.7395 251154104 5. phpdocumentor_intermediateparser->_setupuseslist() /u sr/share/php/PhpDocumentor/phpDocumentor/IntermediateParser.inc:1764 528.7397 251195072 6. __dummyconverter->_createpkgelements() /usr/share/php /PhpDocumentor/phpDocumentor/IntermediateParser.inc:1500 Test script: --------------- The command being used is: phpdoc -d framework -t api -i CVS/\* -o "HTML:frames:phphtmllib" -ti "framework" -dn horde -dc horde --pear The framework module can be checked out from Horde's CVS server (http://horde.org/source/) or downloaded as a snapshot (framework-HEAD-...tar.gz from http://ftp.horde.org/pub/snaps/latest/).]]> 2007-04-27T08:36:29+00:00 jan &#x61;&#116; horde &#x64;&#111;&#x74; org PhpDocumentor Feature/Change Request http://pear.php.net/bugs/7301 PhpDocumentor Feature/Change Request Reported by danielc 2006-04-04T16:47:50+00:00 PHP: Irrelevant OS: Package Version: 1.3.0RC5 Description: ------------ Okay, I know this is kind of "out there," but... It would be really handy to allow @param inside page level docblocks. In large files in large projects, it's helpful to reduce memory consumption by placing the guts of functions inside included files. main.php -------- function somefunc($data) { include 'somefunc.php'; } somefunc.php ------------ /** * @param array $data */ print_r($data);]]> PhpDocumentor Feature/Change Request Reported by danielc 2006-04-04T16:47:50+00:00 PHP: Irrelevant OS: Package Version: 1.3.0RC5 Description: ------------ Okay, I know this is kind of "out there," but... It would be really handy to allow @param inside page level docblocks. In large files in large projects, it's helpful to reduce memory consumption by placing the guts of functions inside included files. main.php -------- function somefunc($data) { include 'somefunc.php'; } somefunc.php ------------ /** * @param array $data */ print_r($data);]]> 2007-04-27T08:35:52+00:00 danielc &#x61;&#116; analysisandsolutions &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/5306 PhpDocumentor Feature/Change Request Reported by drewish 2005-09-05T18:47:15+00:00 PHP: 5.0.4 OS: Package Version: Description: ------------ The {@inheritdoc} tag can be used to include documentation from a base class into members of a derived class. It seems logical that it should work the same way for classes that implement an interface. Test script: --------------- <?php /** * Makes bars */ interface bar { /** * The Baz function * @return void */ function baz(); } /** * Foo bar */ class foo implements bar { /** * {@inheritdoc } */ function baz() { print 'wacka'; } } ?> Expected result: ---------------- Copied and pasted from the browser to give the rough idea: Class Methods method baz [line 23] void baz( string $pork) The Baz function Parameters: string $pork [ Top ] Actual result: -------------- You get the following warning: Warning - {@inheritdoc} can only be used in the docblock of a child class The output (copied and pasted from the browser) looks like: Class Methods method baz [line 23] void baz( mixed $pork) [ Top ]]]> PhpDocumentor Feature/Change Request Reported by drewish 2005-09-05T18:47:15+00:00 PHP: 5.0.4 OS: Package Version: Description: ------------ The {@inheritdoc} tag can be used to include documentation from a base class into members of a derived class. It seems logical that it should work the same way for classes that implement an interface. Test script: --------------- <?php /** * Makes bars */ interface bar { /** * The Baz function * @return void */ function baz(); } /** * Foo bar */ class foo implements bar { /** * {@inheritdoc } */ function baz() { print 'wacka'; } } ?> Expected result: ---------------- Copied and pasted from the browser to give the rough idea: Class Methods method baz [line 23] void baz( string $pork) The Baz function Parameters: string $pork [ Top ] Actual result: -------------- You get the following warning: Warning - {@inheritdoc} can only be used in the docblock of a child class The output (copied and pasted from the browser) looks like: Class Methods method baz [line 23] void baz( mixed $pork) [ Top ]]]> 2007-04-27T08:37:10+00:00 drewish &#x61;&#116; katherinehouse &#x64;&#111;&#x74; com PhpDocumentor Feature/Change Request http://pear.php.net/bugs/4960 PhpDocumentor Feature/Change Request Reported by jacekp@... 2005-08-01T04:58:30+00:00 PHP: Irrelevant OS: Irrelevant Package Version: Description: ------------ currently there is no way to specify different encoding for resulting documentation. Javadoc has --charset switch, which is propagated into resulting HTML (as Meta header).]]> PhpDocumentor Feature/Change Request Reported by jacekp@... 2005-08-01T04:58:30+00:00 PHP: Irrelevant OS: Irrelevant Package Version: Description: ------------ currently there is no way to specify different encoding for resulting documentation. Javadoc has --charset switch, which is propagated into resulting HTML (as Meta header).]]> 2007-10-29T11:46:34+00:00 jacekp &#x61;&#116; poczta &#x64;&#111;&#x74; wprost &#x64;&#111;&#x74; pl PhpDocumentor Feature/Change Request