Уеб връзка в документацията и поддържайте обратна (myLib/index.html) заглавка на връзката

Имам библиотека (да я наречем "myLib"), документирана с помощта на Doxygen, която прави някои (външни) препратки/свързване; за това използвам синтаксиса <a href="/bg../path/to/other/documentation/page/index.html">OtherDoc</a>. Това е напълно добре; работи правилно. Страничният ефект е, че когато щракна върху връзката (и отида на страницата OtherDoc), нямам начин да се върна към myLib, ако не използвам браузъра „върни се назад " бутон.

Това, което си мислех, така че да реша този проблем, е да поддържам заглавка „myLib“ (или като „бележка под линия“), когато потребителят отиде на страницата, свързана с „OtherDoc“. Въпросът ми е: Как да направя това в Doxygen? Също така, има ли по-добър начин за решаване на този проблем с „обратна връзка“?

Наблюдение: html страниците „OtherDoc“ също са генерирана от doxygen документация на друга библиотека, която имам, но тя (OtherDoc) не знае за „myLib“; така че не бих искал да поставям връзки към документацията му към "myLib".

Благодаря предварително. []


person Brandt    schedule 19.09.2012    source източник


Отговори (2)


Предлагам ви да потърсите използването на TAG файлове в Doxygen. Това ще ви позволи да препращате към класове "OtherDoc" (и т.н.) от "myLib" по нормалния начин на "Doxygen".

Това само по себе си няма да позволи "обратни връзки" от "OtherDoc" - без промяна на HTML там.

Алтернативен подход би бил Doxygen да генерира във формат "wiki"; което би позволило динамично генериране на "следи" и обратни връзки. Не ми е известно обаче някой да прави подобно нещо в момента.

person simon.watts    schedule 03.09.2013
comment
Само бърза актуализация - най-новата версия на Doxygen (1.8.8 към момента на писане) вече поддържа опция за конфигуриране BREAD_CRUMB_TRAIL. Ако е зададено на YES, тогава ще се покаже пълната пътека за хлебни трохи за страница, а не само основната група. Все още не съм виждал това в действие. - person simon.watts; 06.10.2014

Ако не искате да добавите обратни връзки в OtherDoc документацията към myLib, тогава защо просто не отворите връзката към OtherDoc в нов раздел или прозорец? По този начин документацията myLib остава отворена и потребителят може просто да се върне обратно към този раздел. От Как да накарам HTML да отваря хипервръзка в друг прозорец или раздел? можете да използвате

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

за вашите връзки. Обърнете внимание на добавянето на target="_blank".

person Chris    schedule 19.09.2012