Documentation

Avec Apache 2.0, l’Apache Group a fait de gros efforts pour documenter correctement l’API. Les en-têtes contiennent des informations pouvant servir à produire une documentation en ligne s’ils sont traités par doxygen, un système documentaire similaire à javadoc, mais conçu pour C et C++ (vous pouvez le télécharger à partir de http://www.stack.nl/~dimitri/doxygen/. Doxygen peut fournir plusieurs formats de sortie, mais le seul que nous supportons activement est HTML, qui peut être généré en tapant simplement :

make dox

à la racine de l’arborescence Apache. L’ancienne cible « docs » tente d’utiliser scandoc au lieu de doxygen, mais cela ne fonctionne pas très bien.

Nous ne reproduirons pas ici les informations disponibles dans la documentation en ligne, mais nous tenterons plutôt d’en présenter une image plus large. Nous avions pensé inclure une copie de cette documentation dans ce livre, mais nous nous sommes ravisés car elle change assez régulièrement. En outre, elle est bien plus pratique sous forme de document HTML que sous forme de document imprimé.