@macro tag

This tag can be used to define a documentation macro which can be expanded using the @invoke tag and @insert tag. A macro can have named arguments.

Syntax

@macro <macro name>
  <macro content>
@end macro

@macro <macro name> [<arg1 name> <arg2 name> ...]
  ... @<arg1 name>@ ...
@end macro

Example

@macro bool_table true_doc false_doc
  @table 2
    @item Value @item Action
 @c -----------------------------
    @item True  @item @true_doc@
    @item False @item @false_doc@
  @end table
@end macro

@invoke {foo() is called} {bar() is called} bool_table