Re: [Doxygen-users] Warning message when documenting overloaded functions.

[<dam...@xc...>]

Hi
I document overloaded functions all the time with no problem. I never use
\fn. Do you get what you want if you omit the \fn?

/*!
* do something with i
*/
virtual void doSomething(int i);

- Damon



                                                                                                                           
  From:       didje <dia...@pd...>                                                                             
                                                                                                                           
  To:         dox...@li...,                                                                         
                                                                                                                           
  Date:       04/22/2015 11:22 AM                                                                                          
                                                                                                                           
  Subject:    [Doxygen-users] Warning message when documenting overloaded	functions.                                       
                                                                                                                           





I am getting a warning message when documenting overloaded functions.

I have an implementation class and a header class.
The header class declares two virtual functions, the second of which
overloads the first.

ClassA.h

/virtual void doSomething(int i);
virtual void doSomething(int i,int j);/


The implementation class implements each virtual function, as 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 to document both doSomething functions in doxygen.
How do I do it?

I have tried documenting the .h file as follows:

*Attempt 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);/

*Attempt 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);/

I have also tried to document the .cpp file in the same way, with and
without documenting the .h file.

However, whichever way I try, I always get the same warning message, which
is:

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

Note: Ideally I would prefer to document only the .cpp file and not the .h
file in order to resolve this problem.




--
View this message in context:
http://cp.mcafee.com/d/5fHCNEi6zqb2pEV78K8zzhOrKrhKyevphsuKrhKyevvod7bVEVdETh7fIEKf8CQrFK8Td7abMUSxGJo2JJzfUwE-ovrBPpYM-TbCQQb41PbX_nUQsEEIK9TWZOWrbVEVV5VNdWX3fbnhIyCHtN_BgY-F6lK1FJ4SOrLOb2rPUV5xcQsCXCM0q5gYIh-78Td7b37g7t3i10_-nM1tz2k29tnWkQzVsMj-1t2JCRvxek29uFDUDRR3Q2XHsbjBm52YRxOb3_0USxkfb4vwnrFYq5O5mUm-wafBiteFlKdLt00_MddLILzzpFr3GxVozY2XtfzgQKCy01tz2k29Ewl-Bd8-q831fU6y12JCRvxek29EwGp-9ZtgZ0QgeJMJelokUSeKrATknCpHd

Sent from the Doxygen - Users mailing list archive at Nabble.com.

------------------------------------------------------------------------------

BPM Camp - Free Virtual Workshop May 6th at 10am PDT/1PM EDT
Develop your own process in accordance with the BPMN 2 standard
Learn Process modeling best practices with Bonita BPM through live
exercises
http://cp.mcafee.com/d/k-Kr41ESyMCqehOby8UQsCXCQrEzDSkn7HCQrEzDTS3hO-qejqdQhPXabzO9J6WrydPhOyYedEqHm0HroP-8afC7SVsSvcfJOVJd2N0sO-_R-d7aabbyt-LsKCO-qeuhusjuKMPORQr8FGTsvVkffGhBrwqrjdICXYyMCY-ehojd79KVI04gH2kZFlSvbUgYKJIpBWKBVjPPfMDj22OFuMgbCphCTFVsSxkfb4vwnrFYq5O5mUm-wafBiteFlKdLt00_MddLILzzpFr3GxVozY2XtfzgQKCy01tz2k29Ewl-Bd8-q831fU6y12JCRvxek29EwGp-9ZtgZ0QgeJMJelokUSeKrdV7O
 event?utm_
source=Sourceforge_BPM_Camp_5_6_15&utm_medium=email&utm_campaign=VA_SF
_______________________________________________
Doxygen-users mailing list
Dox...@li...
http://cp.mcafee.com/d/1jWVIg6hESyMCqehOby8UQsCXCQrEzDSkn7HCQrEzDTS3hO-qejqdQhPXabzO9J6WrydPhOyYedEqHm0HroP-8afC7SVsSvcfJOVJd2N0sO-_R-d7aabbyt-LsKCO-qeuhusjuKMPORQr8FGTsvVkffGhBrwqrpdICXYyMCY-ehojd79KVIDeqR4IM-l9QWBmUSZQ03_0T3VkDj3VkDa3JsgG7ByfMbJQ-d3q5gYIh-1tKDNEn8lrxrW0E-l9QWBmUSZQ03_0QS-O-edCBIeG7ByfMbJQ-d3iWq805Sc9g8Cy1nWkQzVEwc4_wq84aSrl-4Vg8Cy2FDUDRR3Q3h0WT2QVlxjzoWVINfCWyhbQ7kG