Doxygen

If you are a new Irrlicht Engine user, and have a newbie-question, this is the forum for you. You may also post general programming questions here.
Post Reply
LunaRebirth
Posts: 386
Joined: Sun May 11, 2014 12:13 am

Doxygen

Post by LunaRebirth »

Hello,
I'm trying to generate a documentation file for some code, but I'm having some troubles that I'm unsure is possible through doxygen.

My problem is that I have several lua functions that look like

Code: Select all

class LuaCamera
{
    public:
        LuaCamera(lua_State* L);
        static bool defaultControls;
        bool FPSCam;
 
        int lookAt(lua_State* L);
        int getRotation(lua_State* L);
        int setRotation(lua_State* L);
        // ...
 
        virtual ~LuaCamera();
        static const char className[];
        static const Luna<LuaCamera>::RegType Register[];
    protected:
    private:
};
now I want to be able to document, for example, setRotation. In lua, this takes 3 int parameters, but in the C++ code, it takes just the lua_State.
I want it to generate something that instead looks like

Code: Select all

void setRotation(int x, int y, int z)
.

Is there a way that I can get doxygen to output functions differently than they are actually coded, without creating a new unused function as a workaround, so that I can do this?

Note that I also want to be able to make the output list the class reference as "Camera" instead of "LuaCamera" without changing the actual class name. Is this possible?
Post Reply