Donate Share

PhpDocumentor

Tracker: Bugs

1 Error text for Includes without docblock is incorrect - ID: 1585875
Last Update: Settings changed ( ashnazg )

When an include/require line is not provided its own
docblock, an error shows up in errors.html like this:

"Page-level DocBlock precedes "include "main.php"", use
another DocBlock to document the source element"

The problem is that the include file shown is not the
value of the include statement... it is actually
showing the name of the file that the include statement
is in. It should instead be showing what the file
value of the include statement is.

You can duplicate this using these two test files:

main.php
<?php
/**
* Page Directive for main.php
*
* @package Main
*/

include ("helper1.php");
?>

helper1.php
<?php
/**
* Page Directive for helper1.php
*
* @package Main
*/

/**
* source files used as imports
*/
include ("helper2.php");
?>

Because the page-level docblock is the only docblock
preceding the "include helper1.php" statement inside
main.php, it results in the errors.html file showing
this error for main.php:

main.php
Warnings:
Warning on line 7 - Page-level DocBlock precedes
"include "main.php"", use another DocBlock to document
the source element


The error text should instead say:
Warning on line 7 - Page-level DocBlock precedes
"include "helper1.php"", use another DocBlock to
document the source element

I will separately submit a patch that addresses this bug.


Chuck Burgess ( ashnazg ) - 2006-10-27 15:47

1

Closed

Fixed

Chuck Burgess

Parser

None

Public


Comments ( 4 )




Date: 2006-12-22 14:00
Sender: ashnazgProject AdminAccepting Donations


committed patch #1585875 to CVS


Date: 2006-12-21 21:03
Sender: cellogProject Admin


yes, looks good


Date: 2006-12-18 20:16
Sender: ashnazgProject AdminAccepting Donations


I see you assigned this one to me, Greg... is my patch ok with you for me
to commit?


Date: 2006-10-27 15:54
Sender: ashnazgProject AdminAccepting Donations

Logged In: YES
user_id=1608976

Submitted patch #1585879 for this issue.


Log in to comment.




Attached File

No Files Currently Attached

Changes ( 7 )

Field Old Value Date By
close_date - 2007-04-13 18:57 ashnazg
status_id Open 2007-04-13 18:57 ashnazg
priority 6 2007-03-12 14:19 ashnazg
resolution_id None 2006-12-22 14:00 ashnazg
assigned_to cellog 2006-12-17 18:51 cellog
priority 5 2006-10-27 15:55 ashnazg
assigned_to nobody 2006-10-27 15:55 ashnazg