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

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

7 голосов | спросил wip 12 MaramMon, 12 Mar 2012 07:00:12 +04002012-03-12T07:00:12+04:0007 2012, 07:00:12

1 ответ


0

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

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

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

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

ответил Chris 12 MarpmMon, 12 Mar 2012 14:41:28 +04002012-03-12T14:41:28+04:0002 2012, 14:41:28

Похожие вопросы

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132