Espace Autodoc

« Autodoc » est un site généré automatiquement et régulièrement grâce au logiciel PHPDocumentor. Ce logiciel peut analyser les fichiers sources du logiciel SPIP et en extraire certaines informations. Ce sont ces informations, grâce à des gabarits spécifiques (un peu comme les squelettes de SPIP) qui sont ensuite utilisées pour générer des pages statiques en HTML.

Le logiciel PHPDocumentor acceptant des plugins, tout comme SPIP, des plugins ont été créés pour obtenir des informations qui ne sont pas calculées de façon native, tel que collecter les filtres, les balises calculées, les pipelines utilisés, ou encore pour créer des liens automatiquement vers les visualiseurs de code (Redmine pour le Core et Trac pour la Zone)

À noter que la version utilisée de PHPDocumentor est la 2.0.0a13. La prochaine version devrait faciliter grandement la génération des pages HTML mais va nécessiter de reprendre tous les gabarits pour s’adapter au nouveau format. C’est la vie :)

Pour terminer, disons que PHPDocumentor analyse le code source en y recherchant des « docblock » au format « phpDoc ». En gros cela correspond aux commentaires d’en-têtes au dessus des fonctions dans le code source, qui décrit la fonction et ses paramètres. Nous avons ajouté quelques éléments à ceux prévus par défaut, qui sont décrits là : Le PHPDoc dans le code source

Dans la partie « Autodoc » générée à partir de la version en développement de SPIP vous pouvez proposer, via le formulaire prévu une amélioration (ou création) de la documentation des éléments présents dans le code source, au format PHPDoc adapté à SPIP. Les propositions faites se retrouvent alors dans l’espace privé de ce site et peuvent être réintégrées (par les webmestres) au code source de la version de SPIP en développement.