logo       

linking #defines to classes: msg#00119

text.doxygen.general

Subject: linking #defines to classes

Hi all

New to the list, been using and loving Doxygen for quite some time now. The only thing I can't seem to figure out is how I associate my defines with classes / code. An example:

[in file datatypes.h]
#define RESPONSE_NOTHING (1)
#define RESPONSE_SOMETHING (2)
#define RESPONSE_SOMETHING_ELSE (3)

[in file myclass.cpp]
class test {
public:
int WhatResponse();
}

/*!
This function returns the response.
@returns RESPONSE_NOTHING if nothing is there, RESPONSE_SOMETHING if something is there, RESPONSE_SOMETHING_ELSE if something else is there.
*/
int test::WhatResponse() {
}

Now I would like to somehow "link" the defines in the first file together with the class description, but every time I try to even document defines, Doxygen tells me: "Documentation for unknown #define in file whatever.h".

Is there any way to sort of associate the class return value with the defines and what is the proper way to document #defines in the first place?

Thanks in advance.

Regards
Toft

_________________________________________________________________
Use MSN Messenger to send music and pics to your friends http://messenger.msn.co.uk



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf


<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise