Структурирование документации при использовании Doxygen

Я начинаю документировать свою структуру PHP5, используя Doxygen. Я пытаюсь использовать встроенную документацию фреймворка CodeIgniter в качестве ссылки. Однако его документация написана с использованием синтаксиса phpDocumentor. Ниже приведен пример описания класса загрузчика CodeIgniter:

/**
 * Loader Class
 *
 * Loads views and files
 *
 * @package          CodeIgniter
 * @subpackage       Libraries
 * @author           ExpressionEngine Dev Team
 * @category         Loader
 * @link             http://codeigniter.com/user_guide/libraries/loader.html
 */
class CI_Loader {
...
}

Как я могу реализовать ту же структуру (Пакет-> Подпакет-> Категория-> Класс) с помощью Doxygen? Я хотел бы иметь соответствующую страницу описания для каждого элемента структуры.

Еще один вопрос: как вы структурируете документацию вашего проекта?


person ezpresso    schedule 14.01.2011    source источник


Ответы (1)


Если вы используете PHP 5.3, Doxygen поддерживает пространства имен. Если вы поместите их, ваша документация будет структурирована в стиле, аналогичном пакетам phpDocumentor. Взгляните на следующие ссылки для получения дополнительной информации о пространствах имен PHP:

http://php.net/manual/en/language.namespaces.php

http://www.sitepoint.com/php-53-namespaces-basics/

person Jake    schedule 25.02.2011