Revision control

Copy as Markdown

Other Tools

/**
%{if parent}
* @ingroup %{parent}
%{endif}
* @defgroup %{identifier} %{title}
%{if brief}
* @brief `%{identifier}`: %{brief}
%{endif}
%{unless brief}
* @brief `%{identifier}`
%{endif}
*
%{if internal}
* @note This module is not part of the library's public interface.
* Library users may not enable or disable it directly, neither via a
* build policy nor `--enable-modules`. Instead it will be automatically
* added as a dependency of other modules as needed.
*
%{endif}
%{if virtual}
* @note This module is a container for other modules.
* Library users may not enable or disable it directly, neither via a
* build policy nor `--enable-modules`. Please feel free to enable/disable
* the sub-modules listed.
*
%{endif}
%{if deprecated}
* @deprecated This module is scheduled for removal in a future release of the
* library. Users should move away from it before updating to a new
* version of the library. Note that deprecated modules may be explicitly
* disabled using `--disable-modules=MODS` or generically using
* `--disable-deprecated-features`.
%{endif}
%{if experimental}
* @warning This module is marked as 'experimental'. Its functionality and API
* may change in future (minor) releases. Also, its implementation
* quality must be considered 'beta' at best. Applications may still
* enable and use it explicitly via `--enable-modules=MODS` or
* generically using `--enable-experimental-features`. Early feedback
* is very welcome.
*
%{endif}
*
%{if dependencies}
* This module depends on:
%{endif}
%{for dependencies}
* * @ref %{i}
%{endfor}
*
%{if os_features}
* This module requires special operating system features:
%{endif}
%{for os_features}
* * %{i}
%{endfor}
*
%{if cpu_features}
* This module requires special CPU features:
%{endif}
%{for cpu_features}
* * %{i}
%{endfor}
*
%{if arch_requirements}
* This module is exclusively available on some CPU architectures:
%{endif}
%{for arch_requirements}
* * %{i}
%{endfor}
*
%{if compiler_requirements}
* This module is exclusively compatible with certain compilers:
%{endif}
%{for compiler_requirements}
* * %{i}
%{endfor}
*/
/**
* @addtogroup %{identifier}
* @{
%{for public_headers}
* @file %{i}
* @brief Public Header
%{endfor}
* @}
*/
/**
* @addtogroup %{identifier}
* @{
%{for internal_headers}
* @file %{i}
* @brief Internal Header
%{endfor}
* @}
*/
/**
* @addtogroup %{identifier}
* @{
%{for sources}
* @file %{i}
%{endfor}
* @}
*/