Doxygen: ссылки на уценку к заголовочным файлам не работают в html-выводе - PullRequest
Новая
       9

Doxygen: ссылки на уценку к заголовочным файлам не работают в html-выводе

0 голосов
/ 01 ноября 2018

Большинство ссылок в моих файлах уценки корректно отображаются в Doxygen (версия 1.8.14 в Fedora 28), например: 

[utils](src/thing/utils/README.md)

Несмотря на то, что путь к html версии readme для html является загадочным, Doxygen разрешает его, и ссылка работает. Но когда я ссылаюсь на заголовочный файл, Doxygen генерирует странный относительный путь, который никуда не ведет: 

[Widget.hpp](src/thing/utils/Widget.hpp)

На github эта ссылка работает, но путь в html, сгенерированном Doxygen: 

../../src/thing/utils/Widget.hpp

Мне бы хотелось, чтобы Doxygen разрешил эту ссылку на html doc-странице, созданной для Widget.hpp. Есть ли способ сделать это, а также поддерживать совместимость с github? Хорошо, если для этого требуется препроцессор Doxygen или даже мой собственный скрипт предварительной обработки (чтобы запустить до Doxygen и изменить ссылку во временной копии README.md на что-то, что понимает Doxygen).

1 Ответ

0 голосов
/ 01 ноября 2018

Немного о сложной ситуации.

Файл README.md переведен doxygen, и результат используется. Файл widget.hpp также переведен, но поскольку неясно, что связывать, т.е. исходный код или документация, ссылка дается на исходный файл, но в дереве результатов, и этот файл рассматривается как файл, который можно найти в HTML дерево в этой позиции.

Поэтому лучше всего создать путь в каталоге HTML и скопировать файл в это место.

Также было бы хорошо создать проблему в программе решения проблем с кислородом (https://github.com/doxygen/doxygen/issues/new) с приложенным небольшим самостоятельным примером (исходный файл + файл конфигурации в tar или zip; никаких ссылок на внешние источники, пожалуйста, ), что позволяет воспроизвести проблему.

...