2013-10-15 75 views
5

我试图记录一些代码,有很多重载的各种功能。这些功能以非常不同的方式做同样的事情。重载函数文档在Doxygen(C++)

我想使用Doxygen将所有这些功能记录在一起,类似于在cppreference.com(example)中完成的方式。

是否有可能在Doxygen中获得类似的行为?如果是这样,怎么样?

+0

cppreference不使用doxygen ... – Walter

+0

@Walter我意识到这一点。我试图看看我是否可以用Doxygen来模拟这种行为。 :) – Zeenobit

回答

4

有一个类似的问题: Grouping overloads in doxygen

我认为,第一个答案,回答你的问题,因为它会根据集团统一名称的一组功能。我居然给它使用下面的头一试:

#ifndef TEST_H 
#define TEST_H 
/** 
* @brief Test Class 
*/ 
class Test 
{ 
public: 
    ///Default Constructor 
    Test(); 
    /** 
    * @name Overloaded methods 
    */ 
    //@{ 
    ///OverLoad1 
    void func1(void); 
    /** 
    * @brief Overload2 
    * @param a test variable 
    */ 
    void func1(int a); 
    //@} 
}; 
#endif //TEST_H 

如果产生与强力霉素文件,你会看到重载方法组合在一起的简要说明。

我希望有帮助!

+0

谢谢你。我认为这是尽可能的接近。 – Zeenobit