Sign in to follow this  
joanusdmentia

Doxygen & __declspec()

Recommended Posts

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?

Share this post


Link to post
Share on other sites
Yes, you may have to shield that definition with something like the following:


#if (!defined(DOXYGEN))
class __declspec(dllexport) MyClass
#else
class 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? :)

Share this post


Link to post
Share on other sites
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.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

Sign in to follow this