c++ - How to document overloaded functions in Doxygen? -


i getting warning message when documenting overloaded functions.

doxygen version 1.8.7

i have implementation class , header class. header class declares 2 virtual functions, second of overloads first.

classa.h

    virtual void dosomething(int i);      virtual void dosomething(int i,int j);` 

the implementation class implements each virtual function, follows

classa.cpp

    void dosomething(int i) {      printf ("dosomething: %d", i);      }      void dosomething(int i,int j) {      printf ("dosomething: %d", i);      printf ("dosomething: %d", j);      } 

i need document both dosomething functions in doxygen. how do it?

i have tried documenting .h file follows:

attempt 1:

classa.h

    /*!      * \fn void dosomething(int i)      *      */      virtual void dosomething(int i); `      /*!      * \fn void dosomething(int i, int j)      * , j      */      virtual void dosomething(int i,int j); 

attempt 2:

    /*!      * \fn void dosomething(int i)      *      */      virtual void dosomething(int i);       /*!      * \overload void dosomething(int i, int j)      * , j      */      virtual void dosomething(int i,int j); 

i have tried document .cpp file in same way, , without documenting .h file.

however, whichever way try, same warning message, is:

    classa.cpp: warning: no uniquely matching class member found void dosomething(int i)      possible candidates:      virtual void dosomething(int i) @ line 123 of file classa.h      virtual void dosomething(int i, int j) @ line 135 of file class.h      classa.cpp: warning: no uniquely matching class member found void dosomething(int i,int j)      possible candidates:      virtual void dosomething(int i) @ line 123 of file classa.h      virtual void dosomething(int i, int j) @ line 135 of file class.h 

note: ideally prefer document .cpp file , not .h file in order resolve problem.

you have \overload function in doxygen allow


Comments

Popular posts from this blog

c++ - No viable overloaded operator for references a map -

java - Custom OutputStreamAppender not run: LOGBACK: No context given for <MYAPPENDER> -

java - Cannot secure connection using TLS -