Doxygen: как сделать ссылку на исходный файл, написанный на неподдерживаемом языке? - PullRequest
2 голосов
/ 12 января 2012

Мы используем Doxygen для создания документов HTML для кросс-языкового проекта.В какой-то документации я хотел бы сослаться на источник файла, написанного на языке, не поддерживаемом Doxygen (на самом деле это шаблон Visual Studio T4).

В настоящее время я просто записываю имя файла внутрикомментарий к документу.

Включение расширения файла в Doxyfile делает ссылку работоспособной, но Doxygen полностью неверно истолковывает файл и ссылается на эту неверно истолкованную документацию вместо исходного файла, чего я и хочу.*

Однако, если я исключу расширение файла, Doxygen вообще не будет его использовать.

Есть ли какая-либо команда Doxygen для прямой ссылки на источник файла вместо его документации?

Меня не волнует, что Doxygen генерирует неверную документацию для этого файла: если я могу напрямую ссылаться на источник файла , а не на документацию, я буду счастлив.Сами документы настолько явно неверны, что не повредит, что страница сгенерирована и потенциально может быть найдена.

Есть идеи?

1 Ответ

5 голосов
/ 12 января 2012

Я не уверен, что это ответ, который вы ищете, но несколько полезных моментов, которые мы надеемся получить, следуют:

  • Вы можете включить блоки исходного кода с помощью команды \include. Из руководства по Doxygen:

    \include <file-name>

    Эта команда может использоваться для включения исходного файла в виде блока кода. Команда принимает имя включаемого файла в качестве аргумента. Исходные файлы или каталоги могут быть указаны с помощью тега EXAMPLE_PATH файла конфигурации Doxygen.

    Использование команды \include эквивалентно вставке файла в блок документации и окружению его командами \code и \endcode.

  • Также с этой страницы

    Ссылки на файлы.

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

  • и, наконец, из Doxygen FAQ :

    11. Doxygen автоматически генерирует ссылку на класс MyClass где-то в бегущем тексте. Как мне предотвратить это в определенном месте?

    Поставьте % перед именем класса. Вот так: %MyClass. Doxygen удалит % и оставит слово не связанным.

Из последних двух пунктов кажется, что Doxygen автоматически свяжется с документированным файлом, если найдет то, что он считает именем файла. Символ % не позволит Doxygen сделать это, но тогда вам нужно будет найти способ связать код, который вы включили с \include.

Кроме того, см. Мой комментарий к вашему вопросу о том, как остановить создание документации Doxygen для вашего шаблона Visual Studio T4 - я предполагаю, что если вы следовали предложению в комментарии, то Doxygen не будет автоматически помещать ссылку на этот файл (неверно ) документация.

Редактировать : Как обсуждалось в комментариях к вопросу, одним из возможных решений является создание новой страницы для исходного кода и включение источника непосредственно на эту страницу. Например, можно использовать

/*! \page src_code Visual Studio T4 Template
    \include src.tt
 */

Это будет включать страницу под названием «Шаблон Visual Studio T4» на вкладке «Связанные страницы» документации, на которую можно ссылаться с помощью тега src_code (то есть используйте \ref src_code для ссылки на эту страницу / исходный код ).

В заключение, если вы включаете код C / C ++, вы можете заключить в \include команды \code и \endcode, чтобы синтаксис выделил код.

...