Home » Tools and Utilities » PhpDocumentor » Bug #6386

[2006-01-01 12:08 UTC] j dot o dot vik at bio dot uio dot no

Description:
------------
I made a container class with variables for each of several other classes. In the documentation for class variable A::$B I would like to refer to class B, but the link "@see B" ends up referring to A::$B instead. According to the documentation for "punctuationless @see", class names should take priority over class variable names [1]. See the attached test script.

I'm running WAMP5 1.6.0 (www.wampserver.com) with the PHP4 add-on (PHP4.1.1), and phpDocumentor-1.3.0RC5, on Windows XP Pro SP2.

Thanks in advance for any help, and my deepest gratitude to the developers for making such an excellent documentation tool!

Jon Olav Vik

[1]
http://pear.php.net/reference/PhpDocumentor-1.2.3/phpDocumentor/tutorial_tags.see.pkg.html

Test script:
---------------
<?php
/**
* Testing @see item
* @package see-bug
*/
/**
* Unpunctuated @see item won't refer to class item if container::$item exists
* @package see-bug
*/
class container {
/** A class variable */
var $item;
/**
* "@see item" should refer to class item, not class variable container::$item
* @see item
*/
var $doclink;
}
/** @package see-bug */ class item { }
?>

Expected result:
----------------
see-bug/container.html#$doclink should contain a link to see-bug/item.html

Actual result:
--------------
see-bug/container.html#$doclink contains a link to see-bug/container.html#var$item

[2006-02-25 19:30 UTC] j dot o dot vik at bio dot uio dot no

Thank you very much for the "@see object item" trick! I humbly suggest that it be added to the documentation.