Dokumentacja dotycząca struktury podczas używania Doxygen

Question

Zaczynam dokumentować moje środowisko PHP5 za pomocą Doxygen. Próbuję użyć inline dokumentacji CodeIgniter ramy jako odniesienie. Jednak jego dokumentacja jest napisana przy użyciu składni phpDocumentor. Poniżej znajduje się przykład CodeIgniter opis klasy Loader:

/** 
* 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 { 
... 
} 

Jak mogę wdrożyć taką samą strukturę (PAKIET> Subpackage-> Category-> klasa) za pomocą Doxygen? Chciałbym mieć odpowiednią stronę opisu dla każdego elementu struktury.

Kolejne pytanie dotyczy struktury dokumentacji projektu?

Answer 1

Jeśli używasz PHP 5.3, Doxygen obsługuje przestrzenie nazw. Jeśli je umieścisz, twoja dokumentacja będzie miała strukturę podobną do pakietów phpDocumentora. Rzucić okiem na poniższe linki, aby uzyskać więcej informacji na temat nazw PHP:

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

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