首页 > 解决方案 > boost::signals2 函数签名的 Doxygen 文档

问题描述

就像标题中一样:有谁知道如何正确编写 boost::signals2 签名的 Doxygen 文档

/**
 * @brief aSignal
 * void   : aVoidReturn
 * int    : anInteger
 * doulbe : aDouble
 */
boost::signals2::signal<void(int,double)> aSignal;

坦克斯

标签: c++boostdoxygenboost-signals2

解决方案


由于 OP 说我的评论解决方案有效,我将其转为回答。

基本上问题是信号的参数没有名称,只有类型,因此提供这些名称可以解决问题:

struct Foo
{
    /**
    * @brief aSignal
    * @param quantity number of items
    * @param weight mass of items
    */
    boost::signals2::signal<void(int quantity, double weight)> aSignal;
};

https://godbolt.org/z/ezvhcza8s


推荐阅读