Как сделать перекрестную ссылку на уже существующие документы doxygen?

У меня есть два проекта C++ A и B; Зависимость только от B к A.

B  --> A

Я хотел бы отдельно запустить Doxygen на A и B соответственно, но все же позвольте мне сделать перекрестную ссылку на A из B doc. (То есть, когда я просматриваю документ B, я могу напрямую ссылаться на документ A, если есть какой-либо класс из A, используемый в B).

--

[Ответил на ответ от 0x4b:] если я установлю «CREATE_SUBDIRS» с YES и использую относительный путь для файлов тегов, Doxygen каким-то образом сделает неверную ссылку на ссылку.

Я последовал примеру.

 <root>
    +- proj
    |   +- html               HTML output directory for proj   
    |       +- d1
    |       |   +- d2
    |       |       .... (*.html)
    |       | 
    |         ...(*.html)
    |   +- src                sources for proj
    +- ext1
    |   +- html               HTML output directory for ext1
    |   |- ext1.tag           tag file for ext1
    |- proj.cfg               doxygen configuration file for proj
    |- ext1.cfg               doxygen configuration file for ext1

proj.cfg:
OUTPUT_DIRECTORY  = proj
INPUT             = proj/src
TAGFILES          = ext1/ext1.tag=../../ext1/html

ext1.cfg:
OUTPUT_DIRECTORY  = ext1
GENERATE_TAGFILE  = ext1/ext1.tag

Документы под html/ и html/d1/d2 хотелось бы попробовать связать с внешним документом, расположенным в ../../ext1/html. Судя по всему, один из них выйдет из строя.


c++ documentation doxygen
person rnd_nr_gen    schedule 29.11.2010    source источник

Ответы (1)


arrow_upward
5
arrow_downward

Вероятно, вы захотите использовать функцию файла тегов. Когда вы создаете документацию для A, убедитесь, что установлена ​​опция GENERATE_TAGFILE. Когда вы создаете документацию для B, установите значение TAGFILES, чтобы включить результат из A.

[Обновление для адресации относительных путей]

Doxygen довольно хрупок, когда дело доходит до [относительных] путей. Вы ясно понимаете, что использование абсолютного пути решит проблему. Вы можете попробовать взять значение из среды, например. с использованием

TAGFILES          = ext1/ext1.tag=$(PWD)/../ext1/html

чтобы создать абсолютный путь. Это не идеально, но многие значения в Doxyfile зависят от того, где запускается doxygen, а не от того, где находится файл конфигурации.

person Kirk Kelsey    schedule 29.11.2010
comment
ответил в исходном посте. - person rnd_nr_gen; 30.11.2010