[英]How to document overloaded functions in Doxygen?
在記錄重載函數時,我收到警告消息。
Doxygen版本1.8.7
我有一個實現類和標頭類。 頭文件類聲明了兩個虛函數,其中第二個重載了第一個。
ClassA.h
virtual void doSomething(int i);
virtual void doSomething(int i,int j);`
實現類實現每個虛函數,如下所示
ClassA.cpp
void doSomething(int i) {
printf ("doSomething: %d", i);
}
void doSomething(int i,int j) {
printf ("doSomething: %d", i);
printf ("doSomething: %d", j);
}
我需要在doxygen中記錄兩個doSomething函數。 我該怎么做?
我已嘗試記錄.h文件,如下所示:
嘗試1:
ClassA.h
/*!
* \fn void doSomething(int i)
* do something with i
*/
virtual void doSomething(int i); `
/*!
* \fn void doSomething(int i, int j)
* do something with i and j
*/
virtual void doSomething(int i,int j);
嘗試2:
/*!
* \fn void doSomething(int i)
* do something with i
*/
virtual void doSomething(int i);
/*!
* \overload void doSomething(int i, int j)
* do something with i and j
*/
virtual void doSomething(int i,int j);
我也嘗試以相同的方式來記錄.cpp文件,無論是否記錄了.h文件。
但是,無論嘗試哪種方式,我總是會收到相同的警告消息,即:
ClassA.cpp: warning: no uniquely matching class member found for void doSomething(int i)
Possible candidates:
virtual void doSomething(int i) at line 123 of file ClassA.h
virtual void doSomething(int i, int j) at line 135 of file Class.h
ClassA.cpp: warning: no uniquely matching class member found for void doSomething(int i,int j)
Possible candidates:
virtual void doSomething(int i) at line 123 of file ClassA.h
virtual void doSomething(int i, int j) at line 135 of file Class.h
注意:理想情況下,我希望只記錄.cpp文件而不記錄.h文件,以解決此問題。
您在Doxygen中有一個\\ overload函數,可以讓您
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.