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

Question

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

Answer 1

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

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

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

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