Могу ли я сделать так, чтобы doxygen разрешил @ ref для функций стандартной библиотеки C ++?
Иногда я хочу сослаться в моих комментариях к Doxygen на стандартные конструкции библиотеки. Я могу сделать это с помощью HTML <a> элемент — но это много текста, чтобы вставить. Я бы предпочел просто написать {@ref std::string}, и имейте doxygen, знают, что это должно связываться с cppreference.org страница за std::string,
Я подумал, что это возможно, если кто-то создаст файл тегов doxygen для стандартной библиотеки (и даже это может не сработать, если файл тегов не поддерживает произвольные URL-адреса). Так есть ли другой способ сделать это?
Решение
У вас должен быть файл тега Doxygen и соответствующие оффлайн или html файлы. Таким образом, вы можете объявить это в конфигурационном файле Doxygen в следующем формате:
TAGFILES = "/location/of/tagFile=http://onlineUrl Or /location/of/OfflineHtml"Чтобы скачать эти файлы, я нашел два следующих ресурса:
Я рекомендую этот способ. из-за полной документации этого.
Интернет ссылка
- Скачать файл веб-тега.
-
Установите ниже в конфигурационном файле:
TAGFILES += "location/of/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/"
Оффлайн ссылка
- Скачать HTML-книга это автономная копия сайта.
-
Установите ниже в конфигурационном файле:
TAGFILES += "location/of/cppreference-doxygen-local.tag.xml=/location/of/html_book_*\reference\en"
Интернет ссылка
- Скачать файл тегов для последней версии.
-
Установите ниже в конфигурационном файле:
TAGFILES = "/location/of/libstdc++.tag = http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen"
Оффлайн ссылка
- Скачать GCC 7.1 Standard C ++ Библиотека Справочное руководство в HTML. другие найденные версии Вот.
-
Установите ниже в конфигурационном файле:
TAGFILES = "/location/of/libstdc++.tag = /location/of/libstdc++-api-html"
Другие решения
Других решений пока нет …