псевдоним doxygen для структуры, класса и т. д. - PullRequest
Новая
       15

псевдоним doxygen для структуры, класса и т. д.

0 голосов
/ 03 июля 2018

Я хочу создать псевдоним, который внутренне создает команду \struct, которая ссылается на некоторую конкретную структуру и добавляет некоторые дополнительные команды: 

ALIASES += "thing{2}=\struct \2 \n \n \xrefitem thingList\"\" \"List of Things\" \2  this thing belongs to that \ref \1"

псевдоним вызывается в каком-то обычном doxy-комментарии: 

/**
 *
 * \thing{SomeThing, SomeThingStruct}
 *
 * \brief ..sdfsdf
 */
typedef struct sSomeTag SomeThingStruct;

Он в основном делает то, что должен, а также список внешних ссылок генерируется правильно, но я получаю ошибку: 

warning: the name `\_linebr' supplied as the argument of the \class, \struct, \union, or \include command is not an input file

, поскольку он интерпретирует \n в псевдониме как второй аргумент для ключевого слова \struct

Как я могу определить свой псевдоним, чтобы он не выдавал это предупреждение?

1 Ответ

0 голосов
/ 03 июля 2018

См. Документацию по алиасам в документации по доксигену.

Несколько моментов прямо из документации:

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

  • Мы видим здесь использование знака равенства (=) (исправленное в среднем времени, забытое при копировании)
  • использование верхнего регистра <-> нижнего регистра (теперь у вас должно появиться сообщение: warning: Found unknown command \ thing'` (исправлено за это время)
  • использование \n может быть ^^

ТАК что псевдоним должен гласить:

ALIASES += thing{2}="\struct \2 ^^ ^^ \xrefitem thingList\"\" \"List of Things\" \2 this thing belongs to that \ref \1"

...