Strukturieren der Dokumentation bei der Verwendung von Doxygen

Question

Ich fange an, mein PHP5-Framework mit Doxygen zu dokumentieren. Ich versuche, die Inline-Dokumentation des CodeIgniter-Frameworks als Referenz zu verwenden. Die Dokumentation wird jedoch mit Hilfe der phpDocumentor-Syntax geschrieben. Im Folgenden ist ein Beispiel für CodeIgniter des Loader-Klasse Beschreibung:

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

Wie ich die gleiche Struktur umsetzen kann (Package-> Subpackage-> Kategorie-> Klasse) mit Doxygen? Ich hätte gerne eine entsprechende Beschreibungsseite für jedes Element der Struktur.

Eine andere Frage ist, wie strukturieren Sie die Dokumentation Ihres Projekts?

Answer 1

Wenn Sie PHP 5.3 ausführen, unterstützt Doxygen Namespaces. Wenn du sie einträgst, wird deine Dokumentation ähnlich strukturiert wie die Pakete des phpDocumentor. Werfen Sie einen Blick auf die folgenden Links, um weitere Informationen zu PHP Namespaces:

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

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