简体   繁体   中英

Doxygen documentation of boost::signals2 function signature

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

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

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM