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

Bug #11543 empty @todo tags/comments shouldn't be included in TODO list
Submitted: 2007-07-06 14:58 UTC
From: kguest Assigned: ashnazg
Status: Closed Package: PhpDocumentor (version 1.3.2)
PHP Version: 5.1.2 OS: Ubuntu Linux
Roadmaps: 1.4.4    
Subscription  


 [2007-07-06 14:58 UTC] kguest (Ken Guest)
Description: ------------ empty @todo tags/comments shouldn't be included in TODO list. Empty in this context is defined as lack of printable characters. /** * Pet Project. * 06-Jul-2007 * * PHP version 5 * * @category Foo * @package Foo * @access public * @author Ken Guest <kguest@php.net> * @license GPL (see http://www.gnu.org/licenses/gpl.txt) * @link foo.class.php * @todo */ Test script: --------------- <?php /** * Pet Project. * 06-Jul-2007 * * PHP version 5 * * @category Foo * @package Foo * @access public * @author Ken Guest <kguest@php.net> * @license GPL (see http://www.gnu.org/licenses/gpl.txt) * @link foo.class.php * @todo */ ?> Expected result: ---------------- would not expect to see entry for the above in the generated TODO list that phpdoc generates. Actual result: -------------- todo list looks like: Foo foo.class.php *

Comments

 [2007-07-06 15:05 UTC] ashnazg (Chuck Burgess)
This scenario should result in a warning on the Errors page, without showing the empty TODO on either the element's doc page or the overall TODO index list.
 [2009-10-13 08:45 UTC] ashnazg (Chuck Burgess)
-Status: Verified +Status: Closed -Assigned To: +Assigned To: ashnazg -Roadmap Versions: 1.5.0a1 +Roadmap Versions: 1.4.4
Empty TODOs will no longer appear on the overall TODO index listing. However, I'm leaving them visible on the individual elements' docs, so that they remain noticeable.