Doxygen: бесшовная документация для проектов на C ++ и VHDL - PullRequest
Новая
       8

Doxygen: бесшовная документация для проектов на C ++ и VHDL

8 голосов
/ 24 февраля 2011

Я устанавливаю документацию о какой-то библиотеке, которая состоит из C / C ++-части и VHDL-части, а также некоторых поучительных страниц, содержащих только кислород. Их нужно объединить в одну самодостаточную группу. Пока все работает, красиво и пушисто ...

Но что, если я хочу оптимизировать вывод в подкаталоге vhdl с помощью OPTIMIZE_OUTPUT_VHDL = YES и оптимизировать вывод подкаталога c с помощью OPTIMIZE_OUTPUT_C = YES одновременно?

Насколько я понимаю, использование doxygen-tags не является оптимальным в моем случае, так как оно вводит новые файлы doxyfile.conf в каждом подкаталоге с независимыми прогонами doxygen в каждом подкаталоге. Таким образом, делая это, я больше не могу поместить обе части (c + vhdl) в разные подгруппы одной и той же группы, и связи между этими двумя частями невозможны. Кроме того, весь модуль должен быть «автономным», чтобы быть включенным в более крупную документацию, без специальной структуры сборки, используемой в этом решении ...

Что бы вы сделали?

1 Ответ

2 голосов
/ 17 апреля 2012

У меня была та же проблема - в итоге мы сделали следующее:

  1. Создайте другую директорию для кода C и кода VHDL (+ соответствующие файлы комментариев doxygen - так как мы не хотели спамитькод с тегами doxygen везде).
  2. Запустите Doxygen для каждого из этих каталогов (каждый со своим собственным тегом оптимизации - OPTIMIZE_OUTPUT_VHDL или OPTIMIZE_OUTPUT_C)
  3. Объединить (вручную !!! - хотявы можете создать для него скрипт) вывод этих двух каталогов так, чтобы главная страница ссылалась на эти два каталога.

В конце концов я решил сократить время, необходимое для создания документации, и япросто игнорируйте теги оптимизации ...

...