如何同时对多个成员应用警告(就像组中的所有成员一样)?

Question

问题

我有一个文档分成两个不同的组:

• API，供普通用户使用，只有安全功能。
• 低级API，用于更自信的用户。

我在我的Low level API组定义中添加了一个@warning指令，声明该组的所有成员都应谨慎使用。

我希望这个警告显示在组的每个成员的描述中，这样即使用户通过链接等联系到成员，他们也会收到警告。

是否有一种方法可以做到这一点，而不手动将@warning添加到组的每个成员，而是应用每个组/每个文件警告?

的更多信息我的氧版本是1.8.17，但是我应该能够升级它，如果需要的话。我可以编辑项目的所有文件，以及氧配置文件。

期望行为示例

我想实现以下行为:

/** @addtogroup low_level_api
@warning This is a warning I want to display in every member of the group
@{
*/
/** @brief some function of my example
@warning This is a warning I want to display in every member of the group
*/
void some_group_member()
/** @brief another function of my example
@warning This is a warning I want to display in every member of the group
*/
void some_group_member()
/**
@}
*/

不需要在组的每个成员中复制粘贴警告，如假设:

/** @addtogroup low_level_api
@warning_to_all This is a warning I want to display in every member of the group
@{
*/
/** @brief some function of my example
*/
void some_group_member()
/** @brief another function of my example
*/
void some_group_member()
/**
@}
*/

当然，@warning_to_all指令不存在，所以我需要找到一个等价物，即使它是一个更一般和"粗糙"的指令。解决方案，而不是传播警告，例如在每个成员描述中显示组描述。

Answer 1

在OP想要警告的意义上没有真正的分组(据我所知)。一个解决方案可能是使用snippet{doc}命令，如:

/** @addtogroup low_level_api
snippet{doc} this snip
@{
*/
/** @brief some function of my example
snippet{doc} this snip
@warning This is a warning I want to display in every member of the group
*/
void some_group_member();
/** @brief another function of my example
snippet{doc} this snip
@warning This is a warning I want to display in every member of the group
*/
void some_group_member1();
/**
@}
*/
/*
[snip]
@warning This is a general warning I want to display in every member of the group
[snip]
*/