Doxygen documentation of boost::signals2 function signature

76 Views Asked by At

like in the title: does anyone know how to properly write Doxygen documentation of the signature of a boost::signals2

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

Thaanks

1

There are 1 best solutions below

0
On BEST ANSWER

Since OP says my solution from comment works I'm turning that to answer.

Basically problem is that arguments of signal do not have names, only types, so providing those names solves the issue:

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