Doxygen

J’ai passé un peu de temps à configurer la génération de la documentation complète de Clearbricks, avec doxygen, ce qui permet, comme Dotclear l’est déjà (mais il faut que je vérifie ça) de documenter toutes les méthodes et propriétés publiques de la librairie.

Encore un truc que j’avais pas encore bien fouillé et il en ressort qu’il reste un peu de doc à écrire dans le code, même s’il en existe déjà pas mal. Doxygen est plutôt axé C, C++ mais il fait correctement le job avec du PHP, même si la documentation produite présente quelques bizarreries, finalement pas très gênantes.

Il y a donc un fichier de configuration nouveau, nommé .doxygen.conf, à la racine de Clearbricks, et je ferai idem pour Dotclear ; la génération de la doc, créée dans le répertoire doxygen sera effectuée avec un simple :

doxygen .doxygen.conf

Pour me simplifier la vie sur mon Mac, vu que j’ai installé la version GUI de doxygen (version 1.8.4), j’ai créé un alias côté bash :

alias doxygen='/Applications/Doxygen.app/Contents/Resources/doxygen'

Pour référence, la syntaxe servant à extraire la documentation est expliquée sur le site de doxygen et également sur le site de phpDoc .

Il va falloir que j’évalue aussi phpDoc pour me faire une idée, sauf qu’il impose d’avoir une version de PHP supérieure ou égale à 7.0 pour tourner ; alors qu’on ne demande que la 5.5 pour Dotclear, ça me parait un peu too much, même si l’environnement n’est pas le même.

Ou alors j’attends quelques semaines de changer de mac ou d’OS pour utiliser la version 7.n de PHP vu que j’ai la flemme, ce matin, de mettre à jour mon système :-)

Ajouter un commentaire

Les commentaires peuvent être formatés en utilisant une syntaxe wiki simplifiée.

Ajouter un rétrolien

URL de rétrolien : https://open-time.net/trackback/13703

Haut de page