Doxygen: più blocchi Pagina iniziale \ in un progetto

Question

C++ non è stato in grado di determinare ciò che il comportamento di Doxygen è per quanto riguarda la sezione \mainpage, in due casi:

1. Se si specifica nessuna sezione \mainpage, lo fa usa invece un'altra pagina e, in caso affermativo, come viene presa questa?
2. Cosa succede se due file specificano entrambi una sezione \mainpage?

Answer 1

Il comando \mainpage specifica contenuto utilizzato per personalizzare la pagina indice, quindi se ti manca uno è solo una pagina vuota con il normale intestazione Doxygen e piè di pagina.

Penso che la cosa più sicura da dire di avere più \mainpage comandi è che è definito nel senso classico di produrre risultati imprevedibili a seconda della versione e della piattaforma. Allo stesso modo, ho avuto risultati strani quando ho accidentalmente creato più di un comando \page con lo stesso nome di pagina.

ulteriori riflessioni

Spinto da answering another Doxygen question, ricorda che puoi ottenere Doxygen di obbedire alle direttive del preprocessore in modo da poter avere #if condizionali proteggono le molteplici direttive Pagina iniziale ed eseguire diversi file di configurazione sullo stesso codice di base, in cui i file di configurazione definiscono uno dei vari valori di flag.

Ho usato questo generare la documentazione da diverse prospettive approccio di pubblicare Macintosh e Windows-oriented versioni dello stesso riferimento.