Я хочу использовать doxygen для документирования своего PHP-проекта (это плагин WordPress).
Чтобы быть уверенным, что я не перезаписываю существующий класс из любого другого плагина WordPress, я использую метод «class_exist».
Но теперь doxygen генерирует документацию только для моего класса, если я делаю вызов php до определения моего класса.
Пример:
/**
* @author schmitt
*
* @file my_util_class.php
*
* @class my_util_class
*
* @brief small message
*
* big message
*/
if ( ! class_exists( 'my_util_class' ) ) :
//echo "hallo";
class my_util_class
{
/**
* @brief smalltest
* bigtestmessage
*/
public function test() {
return "hallo";
}
//definition of other methods.
}
endif;
если я закомментирую строку эхо «привет» doxygen сгенерирует полную документацию моего класса со всеми методами.
Но если строка закомментирована, только заголовок (определенный с помощью @file и т. Д.) Будет хорошо документирован. Ни один из методов не будет документирован.
Я установил параметр «Извлечь все» в конфигурации doxygen-Config на ДА.
Но это не помогает.
Надеюсь, кто-нибудь может мне помочь. Благодарю.
Задача ещё не решена.
Других решений пока нет …