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

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

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

Ответы

Ответ 1

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

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

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

Ответ 2

Собственно, синтаксис в 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);
}