Использование команды 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

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

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

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

Answer 2

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

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

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

---

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

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

---

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. Это довольно ясно о том, как это сделать, если я понял ваш вопрос.