Inclure SVN log des messages dans Doxygen

Question

Est-il possible de configurer Doxygen pour inclure le journal à partir de SVN pour un fichier dans le cadre de la sortie?Fondamentalement, nous entrons assez rigoureux des messages de log dans le SVN quand on ne s'engage, et je voudrais que les messages ont une section à l'intérieur de la Doxygen sortie.

Answer 1

Je ne sais pas une solution simple ou facile pour cela, mais je pense que vous pouvez rapidement pirater quelque chose ensemble.

• D'abord, vous pouvez générer un fichier HTML à partir du journal de SVN en utilisant la svn2html.xsl stylesheet de la svn2cl outil. Si vous ne l'aimez pas ce qu'il est en fait pas difficile de écrire quelque chose comme ça que vous le pouvez lire dans ce billet de blog .
• Deuxièmement, vous pouvez modifier en quelque sorte le Doxygen sortie d'inclure un lien vers le fichier HTML généré dans la première étape. Je ne sais pas grand-chose à ce sujet, mais peut-être le doxygen page de manuel sur la personnalisation est un bon début .
• Troisièmement, vous pouvez écrire une petite construction fichier pour votre documentation automatise l'étape une et deux éventuellement à l'aide ou faire un script shell ou un fichier batch.

Pas très élégant, mais un début.

Answer 2

Comment sur l'utilisation d'un serveur de build (CruiseControl/Bambou/TeamCity, etc)?Le serveur de build permettrait de surveiller svn pour les changements, et le script de construction (par exemple ant) appels Doxygen dans le cadre de la construction.J'utilise cet arrangement à travailler sur un projet Java et C# combiné construire.Le script de build peut récupérer le dernier message de validation à l'aide de "svn log" avec les options appropriées.

Answer 3

J'aime l'idée, mais ce serait sûrement ne fonctionnera que si vous n'engagé SVN un fichier à la fois - ou la sortie doxygen serait jonché de commentaires non pertinents

?

Je pense que cela peut être fait en utilisant une mise à jour de lot de SVN.

Vous pouvez extraire le SVN qui montrera les dossiers engagés et les commentaires des changements effectués en ouvrant le fichier journal SVN. Je vous crois pouvez écrire un service Windows ou un emploi qui Cron nightly build une liste des fichiers modifiés et leurs commentaires en exécutant autour du fichier journal et la construction d'un dictionnaire ou Hashtable. Avec cela en place ont le Cron / win service ouvert chaque fichier mentionné, recherchez la fin de la section description:

* @section DESCRIPTION 
* 
*  
*
**/

et placez le commentaire dans cette section.