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

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

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

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

Чтобы ты делал?


person marvin2k    schedule 24.02.2011    source источник


Ответы (1)


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

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

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

person Henry Aloni    schedule 17.04.2012