Paramètres de sortie de phpDocumentor

Question

J'ai un bloc de code qui a été écrit il y a un certain temps et que je cherche à documenter, mais l'une des fonctions a un paramètre de sortie - comment un bloc phpDoc doit-il être écrit pour spécifier qu'un paramètre est un paramètre de sortie ?

Note - ce n'est pas "J'aime les paramètres de sortie" ou "Je veux les utiliser", c'est "Ils ont été utilisés, comment sont-ils documentés" :P

Juste au cas où je me serais trompé dans leur nom, quelque chose comme ça :

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

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

Answer 1

Je l'utiliserais :

@param    integer    &$bar    value to be reset

avec le & dans le bloc de paramètres