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

Doc Bug #11032 param type1|type2 not documented
Submitted: 2007-05-14 13:12 UTC
From: ashnazg Assigned: ashnazg
Status: Closed Package: PhpDocumentor (version 1.4.0a1)
PHP Version: Irrelevant OS: Irrelevant
Roadmaps: 1.4.0a2    
Subscription  


 [2007-05-14 13:12 UTC] ashnazg (Chuck Burgess)
Description: ------------ Need to update param (and perhaps return) tag docs to demonstrate using piped datatypes to indicate multiple possible types. This need was highlighted a a phpdocu-open posting at SF: https://sourceforge.net/forum/message.php?msg_id=4310876 This functionality already exists... the docs just need to highlight it better. Test script: --------------- Example: /** * a class with multiple param/return types possible * @param bool flag to determine next param's datatype * @param int|string an int in some cases, string in others * @return int|string int if passed an int, string otherwise */

Comments

 [2007-05-30 22:28 UTC] ashnazg (Chuck Burgess)
Here are the patches to update the tutorial pages for param and return tags, showing how to use multiple pipe-delimited datatypes.
 [2007-05-30 22:40 UTC] ashnazg (Chuck Burgess)
Committed to CVS.