如何为可变参数函数编写Doxygen注释，即具有未定义数量的参数的函数？

Question

I am trying to write a doxygen block comment for a function with unlimited number of parameters, then I couldn't find a right tag for it. Supplied parameters should all be strings, and they will be concatenated in the function to form a new string.

What is the right use of doxygen tags?

Answer 1

A pattern I see frequently in phpdoc (the format of which doxygen understands) is:

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

Yes, literally ... as the variable name.

Answer 2

Actually, the syntax on the phpDocumentor is $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);
}