如何用Doxygen记录专门的C ++构造函数?

时间:2015-04-07 00:00:58

标签: c++ templates doxygen

我有一个看起来像这样的类模板:

template< typename A >
struct MyClassTemplate
{
    /** \brief Foobar.
      */
    MyClassTemplate( A& );
};

template< typename A >
MyClassTemplate< A >::MyClassTemplate( A& )
{
}

template< >
MyClassTemplate< ClassB >::MyClassTemplate( ClassB& )
{
}

Doxygen为MyClassTemplate生成的页面列出了两个构造函数,即一个以A&为参数,另一个为ClassB&。问题是它显示第二个没有文档。它还会产生一个我想要摆脱的警告:

  

MyClassTemplate.h:警告:未记录MyClassTemplate类的成员MyClassTemplate(ClassB&amp;)(函数)。

基于这个警告,我已经尝试过类似的东西了:

/** \fn MyClassTemplate::MyClassTemplate(ClassB&)
  * \brief
  * I am NOT undocumented!!!
  */
template< >
MyClassTemplate< ClassB >::MyClassTemplate( ClassB& )
{
}

但警告仍然存在,MyClassTemplate的页面仍显示未记录的构造函数。如何记录这个s.t. Doxygen了解它吗?

0 个答案:

没有答案