Использование команды doxygen's \ link

Question

У меня есть внешний HTML-файл, который я хотел бы связать с моей вкладкой doxygen "Related Pages" или левой рамкой.Кажется, мне нужно использовать команду \link, но я не могу найти хороший пример того, как ее использовать и где.В настоящее время я использую doxywizard для генерации HTML.

Итак, \link что-то, что я включаю в свой конфигурационный файл doxygen, или я добавляю его при сборке HTML-кода?* Обновление

Поэтому мне пришлось выполнить следующее:

1. Создать новую страницу (docs_main.html), которая имела следующее:

   /*! \mainpage MY TITLE HERE
    * \section intro_sec External resources
    * <a href="link_to_my_external_page.html">My external page</a>
    */
   

2. Включить эту страницу в мой список включенных в Doxygen файлов

3. Восстановить мою документацию

Это добавленона мою doxygen "Main Page" следующую

MY TITLE HERE

My external page (which was a link to that page)

Answer 1

У нас есть поддержка Markdown в doxygen в настоящее время. Ваш код может быть более понятным:

/*! \mainpage MY TITLE HERE
 * \anchor intro_sec
 * # External resources
 * [My external page](http://link_to_my_external_page.html)
 */

Выше должно быть несколько близко к:

---

Внешние ресурсы

Моя внешняя страница

---

Answer 2

Doxygen позволяет вам вставить определенные команды HTML в вашу документацию, включая ссылки. Если вы не знаете, как сделать ссылку в HTML:

<a href="externalfile.html">External file</a>

ответ cdiggins также стоит прочитать.

Answer 3

\ link (и что-либо в форме \ command или @command) называется «специальной командой» и является частью разметки, используемой во входных файлах, обрабатываемых Doxygen, а не частью конфигурации.Команда \ link не делает то, что вы хотите.

Возможно, вы можете использовать команду \ page , чтобы создать новую связанную страницу, а затем использовать \ htmlinclude команда для вставки внешнего HTML-файла в качестве содержимого этой страницы.

Answer 4

Поскольку другие ответы здесь выглядят как кусочки для новичка, вот полная процедура.

1) создайте html-файл с содержимым (например, abc.html), как показано ниже

/*! \mainpage MY TITLE HERE 
 * \section intro_sec External resources
 * <a href="link_to_my_external_page.html">My external page</a>
 */

2) Добавьте этот путь к файлу в конфигурационном файле здесь INPUT =

3) Также добавьте ваш тип файла здесь FILE_PATTERNS =

Приведенная выше процедура открывает ваш файл в окне doxygen

Добавьте приведенное ниже содержимое, чтобы открыть файл в проводнике

<a href="link_to_my_external_page.html" target="_blank"><b>My external page</b></a>

Примечание. Если файл не открывается, попробуйте указать абсолютный путь

Answer 5

Вы можете добавить вкладку на главную панель навигации (со своей ссылкой), используя пользовательский файл макета.

Посмотрите на страницу Настройка вывода руководства Doxygen. О том, как это сделать, понятно, если я понял ваш вопрос.