🔒 Locked

Doxygen & __declspec()

Started by joanusdmentia Dec 1, 2004 at 1:02 AM 1 replies 4.8k views

Original Post

Dec 1, 2004 at 1:02 AM

It would appear that doxygen doesn't like it the following:


// MyClass.h

/// A class.
class __declspec(dllexport) MyClass
{
public:
    /// A brief description.
    void Func();
};


// MyClass.cpp
#include "MyClass.h"


/**
 * A full description.
 */
void MyClass::Func()
{
}

It spits out the warning

Warning: documented function `void MyClass::Func' was not defined.

If I comment out the __declspec() doxygen will recognize it properly, but this obviously won't do since I'm compiling to a dynamic library. Has anyone encountered this problem before or am I doing something stupid?

FReY

Dec 1, 2004 at 1:18 AM

Yes, you may have to shield that definition with something like the following:

#if (!defined(DOXYGEN))class __declspec(dllexport) MyClass#elseclass MyClass#endif{public:    /// A brief description.    void Func();};

Then, you should be able to add the define DOXYGEN to your 'preprocessor' settings under the Doxywizard front-end. I know it's ugly, but it's probably pretty neccessary.

Another thing I haven't tried yet but involves the same kind of trickery. Try keep your source as you have it, then in the Doxywizard 'preprocessor' settings add something like
#define __declspec(x)
This should preprocess all __declspec(dllexports) out of the code before doxygen parses it.

Anything help there? :)

joanusdmentia

Dec 1, 2004 at 1:40 AM

Yep, thanks!

Setting "__declspec(dllexport)=" in the predefines works. You have to be sure to remember the '=' though, not including it will define it as "1" by default.

Topic Locked

This topic has been locked by a moderator. New replies are not allowed.