Веб-ссылка в документации и поддержка заголовка обратной (myLib / index.html) ссылки

У меня есть библиотека (назовем ее «myLib»), документированная с использованием Doxygen, которая выполняет некоторые (внешние) ссылки / ссылки; для этого я использую синтаксис <a href="../path/to/other/documentation/page/index.html">OtherDoc</a>. Это прекрасно; работает должным образом. Побочным эффектом является то, что когда я нажимаю ссылку (и перехожу на страницу OtherDoc), у меня нет возможности вернуться к myLib, если я не использую браузер "вернуться назад " кнопка.

Я думал, чтобы решить эту проблему, чтобы сохранить заголовок «myLib» (или как «сноску»), когда пользователь переходит на страницу, связанную с «OtherDoc». Мой вопрос: как мне это сделать в Doxygen? Кроме того, есть ли лучший способ решить эту проблему с "обратной ссылкой"?

Замечания: html-страницы "OtherDoc" также представляют собой документацию, созданную doxygen для другой библиотеки, которая у меня есть, но она (OtherDoc) не знает о "myLib"; поэтому я не хотел бы помещать ссылки на его документацию на "myLib".

Заранее спасибо. []


doxygen
person Brandt    schedule 19.09.2012    source источник

Ответы (2)


arrow_upward
2
arrow_downward

Я предлагаю вам поискать использование файлов TAG в Doxygen. Это позволит вам ссылаться на классы «OtherDoc» (и т. Д.) Из «myLib» обычным способом «Doxygen».

Это само по себе не позволит использовать "обратные ссылки" из "OtherDoc" - без изменения HTML там.

Альтернативным подходом было бы создание Doxygen в формате «вики»; что позволит динамически генерировать «следы» и обратные ссылки. Однако в настоящее время я не знаю, чтобы кто-нибудь делал подобные вещи.

person simon.watts    schedule 03.09.2013
comment
Просто быстрое обновление - последняя версия Doxygen (1.8.8 на момент написания) теперь поддерживает параметр конфигурации BREAD_CRUMB_TRAIL. Если установлено значение YES, будет отображаться полный след хлебных крошек для страницы, а не только корневая группа. Однако я еще не видел этого в действии. - person simon.watts; 06.10.2014

arrow_upward
1
arrow_downward

Если вы не хотите добавлять обратные ссылки в OtherDoc документации к myLib, то почему бы вам просто не открыть ссылку на OtherDoc в новой вкладке или окне? Таким образом myLib документация остается открытой, и пользователь может просто вернуться на эту вкладку. Из Как заставить HTML открывать гиперссылку в другом окне или на другой вкладке? вы можете использовать

<a href="../path/to/other/documentation/page/index.html" target="_blank">OtherDoc</a>

для ваших ссылок. Обратите внимание на добавление target="_blank".

person Chris    schedule 19.09.2012