2010-06-25 3 views
10

я была не в состоянии определить, что поведение Doxygen в отношении раздела \mainpage, в двух случаях:Doxygen: множественная Главная блоки в C++ проект

  1. Если вы не укажете \mainpage раздела, это делает используйте любую другую страницу, и если да, то как это выбрано?
  2. Что делать, если два файла указывают раздел \mainpage?

ответ

9

Команда \mainpage указывает контент, используемый для настройки индексной страницы, поэтому, если вам не хватает одного, это просто пустая страница с обычным верхним и нижним колонтитулом Doxygen.

Я думаю, что безопаснее всего сказать о том, нескольких \mainpage команды является то, что он находится в классическом смысле приносят непредсказуемые результаты в зависимости от версии и платформ неопределенных. Точно так же у меня были странные результаты, когда я случайно создал более одной команды \page с тем же именем страницы.

Далее мысль

Движимые answering another Doxygen question, помните, что вы можете получить Doxygen подчиняться директивам препроцессора, так что вы можете иметь #if условными защитить несколько директив MainPage и запускать различные файлы конфигурации над той же кодовой базе, где конфигурационные файлы определяют одно из нескольких значений флага.

Я использовал этот генерировать документы с разных точек зрения подход опубликовать Macintosh и Windows-oriented версии одного и того же ссылки.

+1

Кроме того, начиная с doxygen 1.8.3 директива «USE_MDFILE_AS_MAINPAGE» в конфигурационном файле doxygen может настроить, какой файл используется в качестве главной страницы, это позволяет избежать необходимости в директивах препроцессора. –

Смежные вопросы