В документации doxygen, как создать ссылку на определенную строку файла

Question

Существует несколько команд doxygen, целью которых является создание ссылок в документации (@link, @ref).
В настоящее время я использую команду @ref, чтобы создать ссылку на пользовательский файл, написанный на языке, не поддерживаемом doxygen (xml).
Я хотел бы изменить эту ссылку так, чтобы она указывала на точную строку в файле.
Есть ли команда doxygen, которая позволяет это сделать?

Answer 1

Я не уверен, что \ref или \link может это сделать. Однако, если бы они могли, одна из проблем принятия этого подхода состояла в том, что ссылки станут недействительными, если вы измените содержимое файла, на который вы ссылаетесь, без изменения ссылки. Это одна из проблем разделения исходного кода и документации.

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

• включает весь файл с \include (есть также \includelineno) и просто ссылаться на соответствующие части этого в тексте (например, «функция хая в коде ниже»), или
• включают фрагменты файла, в котором вам необходимо обратиться к ним в документации, используя \snippet.

Edit: В качестве альтернативы, вы можете использовать \dontinclude команду, которая, вместе с командами \line, \skip, \skipline и \until позволяет включать конкретные строки/блоки конкретного файла. См. Пример в документации \dontinclude.