Answer the question
In order to leave comments, you need to log in
Trouble generating doxygen documentation for PHP script?
Tried using doxygen for php. Overall impressions are positive, everything is simple, beautiful, convenient. But a few nuances emerged. Perhaps my shortcomings are related to the doxygen configuration, or perhaps bugs in doxygen itself. This is exactly the question I want an answer to.
Essence:
There is a test script, and doxygen under, sorry, windows (I also checked it on linux, the result is similar).
PHP:
<?php
/*!
* @file
*
* Скрипт для тестирования Doxygen версии 1.8.11
*
* @date 2016-05-17
*/
const DSN_SQLITE = 'sqlite:test_sqlite.db'; //!< DSN для SQLite
try {
$lite_db = new PDO(DSN_SQLITE);
} catch (PDOExeption $e) {
echo '!!! Connection to the sqlite failed: '.$e->getMessage();
}
/*!
* @brief Тестовая функция 1.
*
* Функция для тестирования вывода ненужной информации в документацию.
*
* @param $arg1 Целочисленное значение.
* @return Переданное значение увеличенное в 5 раз.
*/
function tst_func1($arg1) {
return $arg1 * 5;
}
$tst1 = tst_func1(5);
if($tst1 == 25) {
echo "Value tst1 = $tst1\n";
}
/*!
* @brief Тестовая функция 2.
*
* Вторая функция для тестирования вывода другой ненужной информации в документацию.
*
* @param $arg2 Целочисленное значение.
* @return Пнреданное значение увеличенное на 5.
*/
function tst_func2($arg2) {
return $arg2 + 5;
}
?>
Answer the question
In order to leave comments, you need to log in
PHP has its own documentation standard ( PSR-5 ), supported by many utilities (PHPStorm, etc.). To generate documentation, you can use phpDocumentor or phpDox (I liked phpDox, there are some problems with phpDocumentor).
Didn't find what you were looking for?
Ask your questionAsk a Question
731 491 924 answers to any question