Ошибка php Doxygen - PullRequest
       5

Ошибка php Doxygen

2 голосов
/ 16 декабря 2010

У меня есть файл php (doxygen.php), который я хотел бы документировать. Проблема в том, что я запускаю doxygen doxygen.php в Linux, он ничего не генерирует ... Файл index.html пуст. Я получаю

Warning: ignoring unknown tag `php' at line 1, file doxygen.php
Warning: ignoring unknown tag `does' at line 4, file doxygen.php
Warning: ignoring unknown tag `nothing' at line 4, file doxygen.php
....

Кажется, что он не распознает комментарии должным образом. Мой файл doxygen.php имеет это:

<?php


/* does nothing
 * @param teste
 * @return null
 */
function foo($foo) {
    echo 'hi'.$foo;
    return null;
}

?>

Ответы [ 3 ]

1 голос
/ 16 декабря 2010

при использовании doxygen вы должны отключить ваши комментарии с помощью

/** ... */

или /*! ... */

см. Doxygen "документирование кода" page

0 голосов
/ 17 февраля 2011

Вы забыли включить данные файла.используйте вместо этого код:

/**
* @file
* Test file intended for doxygen testing
*/


/**
 * does nothing
 *
 * @param teste
 * @return null
 */

function foo($foo) {
    echo 'hi'.$foo;
    return null;
}

Это будет работать.проверил это моим доксигеном.

0 голосов
/ 16 декабря 2010

Попробуйте

/**
 * does nothing
 *
 * @param teste
 * @return null
 */
...