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

у меня есть внешний HTML-файл, который я хотел бы связать с моей вкладкой doxygen "связанные страницы" или левой рамкой. Кажется, мне нужно использовать но я не могу найти хороший пример того, как использовать его и где. В настоящее время я использую 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 "главной странице" следующее

MY TITLE HERE

My external page (which was a link to that page)
9
doxygen doxywizard

5 ответов

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

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

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

11

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

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

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

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

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

13

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

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

3

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

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

0

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

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

добавьте содержимое ниже, чтобы открыть файл в исследователь!--5-->

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

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

0