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

89
9

Существует несколько команд doxygen, целью которых является создание ссылок в документации (@link, @реф).

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

Я хотел бы изменить эту ссылку, чтобы она указывала на точную строку в файле.

Есть ли команда doxygen, которая позволяет это сделать?

спросил(а) 2012-03-12T06:00:00+04:00 7 лет, 9 месяцев назад
1
Решение
86

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


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

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

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

ответил(а) 2012-03-12T13:41:00+04:00 7 лет, 9 месяцев назад
Ваш ответ
Введите минимум 50 символов
Чтобы , пожалуйста,
Выберите тему жалобы:

Другая проблема