Function getComments

buildtools/make_struct.php:174–199

* @brief Get the comment block of a function. * Adds see/return doxygen tags * @param string $currentFunction function name * @param string $returnType Return type of function * @param array $parameters Parameter names * @return string Comment block */

(StructGeneratorInterface $generator, string $currentFunction, string $returnType, array $parameters)

 * @return string Comment block
 */
function getComments(StructGeneratorInterface $generator, string $currentFunction, string $returnType, array $parameters): string
{
    global $header;
    /* First find the function */
    foreach ($header as $i => $line) {
        if (preg_match('/^\s*void\s+' . $currentFunction . '\s*\(.*' . join('.*', $parameters) . '.*command_completion_event_t\s*callback\s*/', $line)) {
            /* Backpeddle */
            $lineIndex = 1;
            for ($n = $i; $n != 0; --$n, $lineIndex++) {
                $header[$n] = preg_replace('/^\t+/', '', $header[$n]);
                $header[$n] = preg_replace('/@see (.+?)$/', '@see dpp::cluster::' . $currentFunction . "\n * @see \\1", $header[$n]);
                $header[$n] = preg_replace('/@param callback .*$/', '@return ' . $returnType . ' returned object on completion', $header[$n]);
                if (preg_match('/\s*\* On success /i', $header[$n])) {
                    $header[$n] = "";
                }
                if (preg_match('/\s*\/\*\*\s*$/', $header[$n])) {
                    $part = array_slice($header, $n, $lineIndex - 1);
                    array_splice($part, count($part) - 1, 0, $generator->getCommentArray());
                    return str_replace("\n\n", "\n", join("\n", $part));
                }
            }
            return '';
        }
    }
    return '';
}

/* Finished parsing, output autogenerated files */
$generator->saveHeader($content);