[AlternC-dev] Devcamp 3.3 - J-20

Retour à l'archive de la liste
Le site d'AlternC
Google Custom Search

Alban Crommer alban at octopuce.fr
Mer 12 Mar 11:36:32 CET 2014


Bonjour,

Une documentation automatique d'alternc est disponible sur : http://doc.alternc.org

Ce sous domaine existait avec de vieilles pages devenues inaccessible sauf une doc hors d'âge pour Cacti. J'ai redirigé vers le nouveau serveur.

La documentation automatique est faite avec Doxygen (fichier de configuration joint). C'est Doxygen qui nous a fourni le meilleur résultat pour du HTML : il y a même un petit moteur de recherche en JS sur la droite, et dans l'ensemble tout est quand même confortable et bien pensé.

Quelques points : 

*    Si vous connaissez un meilleur logiciel, on peut essayer. J'ai testé phpdox et j'eu testé phpDocumentor. Ici on trouve généralement Doxygen supérieur mais c'est ouvert.

*    Cette documentation traduit l'état actuel de documentation des classes et des fonctions. Espérons que ça nous encourage à mieux documenter :)

*    Cette documentation est "en l'état" : On ajouterait une page d'accueil avec des liens etc.

*    @azerttyu est-ce qu'on insére ce site dans le réseau des sites Alternc ? C'est très technique comme type de site mais ça peut servir. Auquel cas, on aurait le widget du ring sur la page d'accueil.

*    Je propose qu'on applique cette documentation à la dernière version et qu'à terme on en fournisse une pour les futures versions ie ( http://doc.alternc.org/3.2 etc. )

-------------- section suivante --------------
Une pièce jointe autre que texte a été nettoyée...
Nom: Doxyfile
Type: application/octet-stream
Taille: 78757 octets
Desc: non disponible
URL: <http://lists.alternc.org/arch/dev/attachments/20140312/4336222a/attachment-0001.obj>


Plus d'informations sur la liste de diffusion Dev