开发者

Structuring documentation when using Doxygen

开发者 https://www.devze.com 2023-02-04 22:32 出处:网络
I am starting to document my PHP5 framework using Doxygen. I am trying to use CodeIgniter framework\'s inline documentation as a reference. However, its documentation is written using phpDocumentor sy

I am starting to document my PHP5 framework using Doxygen. I am trying to use CodeIgniter framework's inline documentation as a reference. However, its documentation is written using phpDocumentor syntax. Below is an example of CodeIgniter's Loader class description:

/**
 * Loader Class
 *
 * Loa开发者_如何转开发ds 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 {
...
}

How can I implement the same structure (Package->Subpackage->Category->Class) using Doxygen? I would like to have a corresponding description page for each element of the structure.

Another one question is how do you structure your project's documentation?


If you are running PHP 5.3 then Doxygen supports namespaces. If you put them in then your documentation will be structured in a similar style to the phpDocumentor's packages. Have a look at the following links for more information about PHP namespaces:

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

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

0

精彩评论

暂无评论...
验证码 换一张
取 消