Как написать помощи Doxygen комментарий к вариативная функция, т. е. функция с неопределенным количеством аргументов?

Я пытаюсь написать комментарий блока doxygen для функции с неограниченным количеством параметров, тогда я не смог найти правильный тег для нее. Все поставляемые параметры должны быть строками, и они будут объединены в функции для формирования новой строки.

Как правильно использовать теги doxygen?

11
comments doxygen function php variadic

2 ответов

шаблон, который я часто вижу в phpdoc (формат которого doxygen понимает):

/** 
 * Shortdesc.
 * Longdesc.  Longdesc.  Longdesc.  Longdesc.  
 * @param mixed $something Description
 * @param mixed ... Description
 */
    function foo() { ... }

да, буквально ... в имя переменной.

12

на самом деле синтаксис phpDocumentor является $paramname,...

/**
 * Builds a file path with the appropriate directory separator.
 * @param string $segments,... unlimited number of path segments
 * @return string Path
 */
function file_build_path(...$segments) {
    return join(DIRECTORY_SEPARATOR, $segments);
}
5