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

Doc Bug #10972 @method does not work
Submitted: 2007-05-07 13:19 UTC Modified: 2007-05-30 17:38 UTC
From: tswicegood Assigned: ashnazg
Status: Closed Package: PhpDocumentor (version 1.4.0a1)
PHP Version: 5.2.1 OS: Ubuntu (feisty)
Roadmaps: 1.4.0a2    
Subscription  


 [2007-05-07 13:19 UTC] tswicegood (Travis Swicegood)
Description: ------------ When using the @method[1] tag that's specified in the manual, it does not properly add a new method to a class, instead it only adds a new item to the unordered list in the class summary. [1]: http://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.method.pkg.html Test script: --------------- Add the following to the file: * @method int borp() borp(int $int1, int $int2) multiply two integers Expected result: ---------------- Expect new method listed within documentation Actual result: -------------- Adds list item with text of: method: int borp(): borp(int $int1, int $int2) multiply two integers

Comments

 [2007-05-07 13:58 UTC] ashnazg (Chuck Burgess)
All the new "magic" tags were only designed to highlight the fact that a class had such magic items... they're not designed to actually show magic variables as distinct entities in the generated documents. Since such magic items are not generally declared/initialized, you can't really docblock them, which is the only way to create distinct entities in the generated documents. That's why there was a need for a way to show that such magic items did exist in a class. Since they only mattered to the class, it was decided to put the tags in the class docblock. So, using the magic tags means your class-level info will show your notes about the magic items, but it does _not_ result in property items being listed just like variables and method items being listed just like functions. I'll see if I can update the tag descriptions in the manual to show the expected results of using the tags.
 [2007-05-07 15:12 UTC] ashnazg (Chuck Burgess)
Discussion on how the tags were implemented occurred last summer on Greg Beaver's blog: http://greg.chiaraquartet.net/archives/140-phpDocumentor-and-__get__set__call-give-us-your-ideas-RFC.html
 [2007-05-30 17:32 UTC] ashnazg (Chuck Burgess)
Here are the patches that update the description of the generated docs when these magic tags are used.
 [2007-05-30 17:38 UTC] ashnazg (Chuck Burgess)
Committed to CVS.