Doxygen alias похоже на \ see или \ sa

Question

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

например.

\foo One 
\foo Two 
\foo Three 

Если в конечном итоге, как

Foo: 
    One 
    Two 
    Three 

Длинная короткая история: псевдоним, который ведет себя как \see, но имеет другую метку.

Answer 1

Посмотрите на команду \xrefitem. Из документации Doxygen (курсив мой):

Эта команда является обобщением таких команд, как \todo и \bug. Его можно использовать для создания пользовательских текстовых разделов, которые автоматически перекрестно ссылаются между местом возникновения и связанной с ним страницей, которые будут сгенерированы. На соответствующей странице будут собраны все разделы одного типа.

пример в документации предполагает, что вы поместите псевдоним

ALIASES += "reminder=\xrefitem reminders \"Reminder\" \"Reminders\"" 

в файле конфигурации. Тогда писать что-то вроде

\reminder test 1 
\reminder test 2 
\reminder test 3 

в документации приведет к чему-то вроде:

Reminder: 
    test 1 
    test 2 
    test 3 

Единственная проблема состоит в том, что вы будете под дополнительной странице под заголовком «Посторонние страницы» вкладки под названием «Напоминания ». Если вы не хотите этого, связанную страницы, которую вы можете использовать псевдоним как описаны в документации custom commands:

ALIASES += sideeffect="\par Side Effects:\n" 

, который позволит поставить команду \sideeffect в документации, что приведет к определенному пользователю пункта с заголовком Побочные эффекты:. Однако они не будут сгруппированы вместе в окончательной документации (то есть каждый \sideeffect будет генерировать побочные эффекты:).