Doxygen поместил тег HTML после команды @snippets - PullRequest
0 голосов
/ 04 мая 2019

Я создал ALIAS для встраивания \snippet в HTML <div></div>

ALIASES += "snippetLang{2}=<div id='\1' class='snippetcontent'> \snippet \2 </div>"

Затем я использую псевдоним так:

@snippetLang{CS,ExampleForm.cs OnShow example}

Параметры расширяются нормальноно поскольку второй параметр сниппета расширяется до конца строки, тег </div> будет включен.

<div id='CS' class='snippetcontent'> \snippet ExampleForm.cs OnShow example </div>

Команда \snippet теперь будет искать ссылку "OnShow example </div>" вместо толькоthe "OnShow example"

Есть ли способ заставить doxygen развернуть команду, где \snippet \1 находится в отдельной строке, например так?

<div id='CS' class='snippetcontent'>
\snippet ExampleForm.cs OnShow example
</div>

Версия Doxygen - 1.8+0,14

1 Ответ

1 голос
/ 04 мая 2019

Из документации doxygen (1.8.15):

Псевдонимы Этот тег можно использовать для указания количества псевдонимов, которые выступают в качестве команд в документации.Псевдоним имеет вид: name = value Например, добавление «sideeffect = @ par Side Effects: \ n» позволит вам поместить команду \ sideeffect (или @sideeffect) в документацию, что приведет к пользовательскому абзацус заголовком «Побочные эффекты:».Вы можете поместить \ n в часть значения псевдонима для вставки новых строк (в результате вывода).Вы можете поместить ^^ в часть значения псевдонима, чтобы вставить новую строку, как если бы физический символ новой строки был в исходном файле.Когда вам нужен литерал {или} или, в части значения псевдонима вы должны экранировать их с помощью обратной косой черты (), это может привести к конфликтам с командами {и}, для них рекомендуется использовать версию@ {и @} или используйте двойное экранирование (\ {и \})

Версия:

ALIASES += "snippetLang{2}=<div id='\1' class='snippetcontent'> \snippet \2 ^^</div>"

будет работать для версии 1.8.14 и выше

версия

ALIASES += "snippetLang{2}=<div id='\1' class='snippetcontent'> \snippet \2 \n</div>"

будет работать для версий до 1.8.14

...