Doxygen w / XCode & Subversion questions

Question

Je suivais ce guide d'Apple pour créer la documentation doxygen. Je ne dois modifier le script pour mettre les variables entre guillemets alors quand il analyse un répertoire avec des espaces, il ne traite pas comme deux arguments distincts.

Cela dit, j'ai récemment passé à utiliser la subversion dans Xcode au lieu d'utiliser la substance Snapshot, qui a une histoire notoire avec elle-même et corrompant perdre votre histoire. Mon processus pour faire c'était de créer une subversion comme la structure de répertoire pour mon projet, vérifiez que dans SVN, puis vérifiez consulter à partir du tronc.

Mon problème est que lorsque je crée la documentation, peu importe comment je modifier mon fichier de configuration doxygen (de exclude_parameters, etc ...), la première fois qu'il crée pour la documentation Doc Niveau, il est très bien. La deuxième fois qu'il traverse, il a des problèmes en essayant de copier avec la commande cp à mon répertoire de documentation bibliothèque où il est installé pour XCode référence.

Je l'ai essayé d'ajouter aux exclude_parameters .svn * svn * * /. Svn * * /. Svn / * mais rien ne semble aider ou affecter la documentation. Je l'ai fait une chmod sur mon après est Doc Niveau installé, et qui résout le problème, mais il est vraiment juste masquer le fait que les répertoires .svn sont encore présents dans la documentation.

Je pensais que peut-être créer une action de dossier pourrait faire l'affaire, mais je ne l'ai pas vraiment foiré autour avec des scripts de pomme beaucoup. Ce serait un hack, mais serait certainement faire le travail.

Pour ce faire droit cependant, que quelqu'un a une idée de comment le faire avec élégance (la manière correcte)?

Merci!

Answer 1

Je ne sais pas exactement où votre problème est, donc je vais essayer de décrire la façon dont je travaille avec svn, doxygen et Xcode. Je l'ai écrit un guide plus complet que cette réponse, mais il est malheureusement en français.

En ce qui concerne les fichiers source, ma structure de répertoire du projet est plat: pas de code source est dans des sous-dossiers (valeur par défaut lorsque vous gérez le code avec Xcode seulement). Mon Doxyfile contient ce paramètre:

RECURSIVE = NO

De cette façon, les répertoires ne sont pas analysés .svn par doxygen.

En ce qui concerne docsets, mon Doxyfile contient les paramètres suivants:

GENERATE_DOCSET        = YES
DOCSET_FEEDNAME        = "My wonderful Application"
DOCSET_BUNDLE_ID       = com.example.mywonderfulapp

et regarde mon script comme ceci:

# Where are doxygen and dot (assuming in my own Applications folder)
DOXYGEN_PATH=${HOME}/Applications/Doxygen.app/Contents/Resources
PATH=${DOXYGEN_PATH}:${PATH}
export PATH

# Doxygen documentation generation
doxygen || exit 1

# DOCSET generation
make -C html install || exit 1

# Open DOCSET in Xcode
DOCSET_PATH=Library/Developer/Shared/Documentation/DocSets
open $HOME/$DOCSET_PATH/fr.exemple.doxygentutorial.docset || exit 1

Avec ces paramètres, je ne l'ai pas rencontrer des problèmes comme ceux que vous décrit.

Answer 2

Vous ne devriez pas avoir une structure de répertoire plat sur votre projet. Que faire si vous voulez internationaliser?

La façon d'éviter ces erreurs cp est d'ajouter le paquet à la liste Doc Niveau des fichiers ignorés par SVN. Si elle est ignorée, il est pas versionné et si ce n'est pas versionné il n'y a pas de fichiers svn pour cp de se plaindre.

J'utilise la ligne de commande client SVN donc YMMV, mais voici ce que je faisais:

• Tout d'abord, mettre à jour svn votre copie de travail pour vous assurer que vous êtes synchronisé avec le référentiel.
• En second lieu, supprimer svn le répertoire du référentiel Doc Niveau et validation.
• Troisièmement, construire le projet pour générer un nouveau répertoire de Doc Niveau (celui-ci est sans version).
• Ajoutez à SVN ignorer et commit
• Faites état svn pour vous assurer que tout est ok. Vous devriez maintenant être en mesure de travailler sans problème.

J'ai passé deux ou trois heures essayant de se faire, mais maintenant je peux construire mon projet à volonté sans être induit en erreur par ces erreurs faux et j'ai mon Doc Niveau.