Могу ли я использовать обратные тики и скобки с помощью doxygen @ref?

#comments #doxygen #code-documentation #cross-reference #backticks

#Комментарии #doxygen #код-документация #перекрестная ссылка #обратные метки

Вопрос:

Я хочу, чтобы комментарий doxygen в моем коде на C ссылался на определенную функцию; скажем, в другом пространстве имен : foo::bar() . И давайте проигнорируем возможность того, что эта функция перегружена. И я также хотел бы, чтобы имя функции было задано так же, как и содержимое в обратных метках в моих комментариях doxygen.

Имея это в виду, какие из следующих действий должны привести к описанному мной эффекту?

 @ref foo::bar
@ref foo::bar()
@ref `foo::bar`
@ref `foo::bar()`

или — возможно, что-то еще?

1. «что из следующего я должен использовать?» мое мнение основано на мнении. Что работает? что не так? Какая версия doxygen.

2. @albert: Уточнил, я хочу знать, какой из них должен работать.

3. Ну, последние 2 выдают предупреждение, поскольку они не содержат допустимых меток.

4. @albert: Но разве первые два не приводят к тексту ссылки, который не является моноширинным?

5. Они имеют тип / стиль письма, который определен в файле doxygen.css. Смотрите a.el в doxygen.css (в моем случае это строка 216).

Ответ №1:

В документации к ref команде указано:

ref [«(текст)»]

Создает ссылку на именованный раздел, подраздел, страницу или привязку. Для документации HTML команда reference сгенерирует ссылку на раздел. Для раздела или подраздела название раздела будет использоваться в качестве текста ссылки. Для привязки будет использоваться необязательный текст между кавычками или если текст не указан. Для документации LATEX команда reference сгенерирует номер раздела для разделов или текст, за которым следует номер страницы, если он ссылается на привязку.

В ref команде первым аргументом является the <name> , и a <name> не может содержать обратную галочку.

Чтобы получить запрошенную возможность ссылки с одним интервалом, можно для HTML (только!) Настроить / расширить используемую запись в таблице стилей.

Для начала:
в таблице стилей doxygen по умолчанию doxygen.css мы имеем:

 a.el {
        font-weight: bold;
}

Изменив эту запись на, например

 a.el {
        font-family: monospace, fixed;
        font-weight: normal;
}

Лучше всего не переопределять doxygen.css и указывать это как параметр HTML_STYLESHEET ,
а создать новую, дополнительную таблицу стилей и указать это в HTML_EXTRA_STYLESHEET .

Обратите внимание, что это повлияет на все ссылки, а не только на ref них.

1. a.el Используется только для ссылок, созданных из-за @ref или @see ? Или также для других ссылок?

2. Также для других ссылок

3. Я понимаю. Итак, я ничего не могу сделать, чтобы изменить стиль для конкретной ссылки @ref / @see ? Или для подмножества из них?

4. Нет, не совсем, только создайте запрос на улучшение в doxygen bug tracer . единственное, о чем можно подумать, это использовать и ALIAS в сочетании с htmlonly или, может anchor быть, но это было бы очень сложно и сложно, и я не уверен, что это приведет к результату.