phpDocumentor Output Parameters

Question

I've got a block of code which was written a while ago and I'm looking to document, but one of the functions has an output parameter - how should a phpDoc-block be written to specify that a parameter is an output parameter?

Note - this isn't "I love output parameters" or "I want to use them", it's "They were used, how are they documented?" :P

Just in case I've got the name of them wrong, something like this:

function foo (&$bar)
{
    $bar = 1;
    return 2;
}

$varIs2 = foo($varIs1);
echo $varIs1; // 1
echo $varIs2; // 2

score 3 · Accepted Answer · answered Feb 15 '12 at 16:17

3

I'd use:

@param    integer    &$bar    value to be reset

with the & in the param block

answered Feb 15 '12 at 16:17

Mark Baker

209,507
32
346
385

You know how sometimes you can't think of how to do something, then someone comes in and suggests something that then seems really obvious? Yeah... lol. Cheers :) – Joe Feb 15 '12 at 16:50

phpDocumentor Output Parameters

1 Answers1