Я понимаю, что аннотацию @return можно использовать, когда функция возвращает что-то, например:
@return int The count of created elements
Что если функция возвращает, например, код состояния? Я хотел бы документировать все значения кода статуса в аннотации. Можно ли это сделать?
Конечно, я могу делать то, что следует, но я сомневаюсь, что PHPDoc действительно увидит эту информацию как потенциальные значения, а не как обычный текст.
/**
* @ return int The status code
0 => Success
1 => Connection failure
2 => Bad parameters
*/