Doxygen documentation of boost::signals2 function signature

Question

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

Which version of doxygen? What did you try so far and where do you have problems? — albert, Apr 23 '21 at 11:08

score 1 · Accepted Answer · answered Apr 23 '21 at 16:34

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

Doxygen documentation of boost::signals2 function signature

1 Answers1