Структурирование документации при использовании Doxygen - PullRequest
5 голосов
/ 14 января 2011

Я начинаю документировать мою среду PHP5, используя Doxygen.Я пытаюсь использовать встроенную документацию CodeIgniter для справки.Однако его документация написана с использованием синтаксиса phpDocumentor.Ниже приведен пример описания класса Loader 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 {
...
}

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

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

1 Ответ

3 голосов
/ 26 февраля 2011

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

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

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

...