Doxygen: несколько блоков \ mainpage в проекте C ++ - PullRequest
10 голосов
/ 25 июня 2010

Я не смог определить поведение doxygen по отношению к разделу \mainpage, в двух случаях:

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

1 Ответ

9 голосов
/ 25 июня 2010

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

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

Дальнейшая мысль

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

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

...