Doxygen w / XCode & Issues Subversion

Question

questa guida da Apple per creare la documentazione Doxygen. Ho avuto bisogno di modificare lo script di mettere le variabili tra virgolette in modo che quando si analizza una directory con gli spazi, non trattarlo come due argomenti separati.

Detto questo, di recente sono passato a utilizzare la sovversione in Xcode invece di utilizzare la roba Snapshot, che ha una storia noto con corrompere sé e di perdere la vostra storia. Il mio processo per fare tale era quello di creare una sovversione come struttura di directory per il mio progetto, verificare che in SVN, quindi controllare il check-out dal tronco.

Il mio problema è che quando creo la documentazione, non importa quanto a modificare il mio file di configurazione Doxygen (exclude_parameters, ecc ...), la prima volta che si crea il Documentation Index per la documentazione va bene. La seconda volta che passa attraverso, ma ha problemi che cercano di copiare con il comando cp alla mia directory documentazione della libreria in cui è installato per XCODE fare riferimento.

Ho provato ad aggiungere alle exclude_parameters .svn * .svn * * /. Svn * * /. Svn / * ma nulla sembra aiutare o influenzare la documentazione. Ho fatto un chmod sul mio Documentation Index dopo l'installazione, e che risolve il problema, ma in realtà è solo mascherare il fatto che le directory .svn sono ancora presenti nella documentazione.

Ho pensato che forse la creazione di una cartella di azione potrebbe fare il trucco, ma non ho davvero pasticciato con gli script di mele più di tanto. Sarebbe un hack, ma sarebbe certamente ottenere il lavoro fatto.

Per fare questo diritto, però, qualcuno ha un'idea di come fare questo con grazia (il modo corretto)?

Grazie!

Answer 1

Non so esattamente dove il problema è, quindi cercherò di descrivere come io lavoro con svn, doxygen e Xcode. Ho scritto un rel più completa guida di questa risposta, ma purtroppo è in francese.

Per quanto riguarda i file di origine, la mia struttura directory del progetto è piatta: nessun codice sorgente è in sottocartelle (questa è l'impostazione predefinita quando si gestisce solo il codice con Xcode). Il mio Doxyfile contiene questa impostazione:

RECURSIVE = NO

In questo modo, .svn directory non vengono analizzati da doxygen.

Per quanto riguarda docsets, il mio Doxyfile contiene le seguenti impostazioni:

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

e il mio script è simile al seguente:

# 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

Con queste impostazioni non ho esperienza problemi come quelli che si descrive.

Answer 2

Non si dovrebbe avere una struttura di directory piatta sul progetto. Che cosa succede se si vuole internazionalizzare esso?

Il modo per evitare quegli errori CP è quello di aggiungere il pacchetto DocSet alla lista dei file ignorati da SVN. Se è ignorato non è di versione e, se non è di versione non c'è nessun file Svn per cp di cui lamentarsi.

sto usando la linea di comando client SVN così YMMV, ma ecco quello che ho fatto:

• In primo luogo, aggiornare svn vostra copia di lavoro per assicurarsi che si sta sincronizzato con il repository.
• In secondo luogo, svn cancellare la directory DocSet dal repository e impegnarsi.
• In terzo luogo, costruire il progetto per generare una nuova directory insieme (questo è sotto controllo di versione).
• Aggiungi a SVN ignorare e commit
• Fare svn status per assicurarsi che tutto è ok. Si dovrebbe ora essere in grado di lavorare senza problemi.

Ho trascorso un paio di ore per capire questo fuori, ma ora posso costruire il mio progetto a volontà, senza essere ingannati da questi errori falso e io ho il mio DocSet.