Hi everyone,
I've just started to document my Game Engine, called Fusion. It's built
of a static lib which is linked against any application which is using
Fusion, then a set of DLL modules which accompany the exe to provide the
functionality of fusion, the implementation if you will.
I wanted to provide documentation which would group in terms of Fusion
Core, then each of the DLL modules separately, but at the moment, it's
extracting all the classes into one big list, I want to break that list up,
into chunks according to how they are related, Fusion objects within the
Fusion Core, would be grouped under Fusion for example, then the Graphics
Subsystem would list all the classes it had under it, etc, etc, etc.
Example:
Fusion
FusionCore
FusionObject
Graphics
OGLGraphics
OGLSurface
DG8Graphics
OGLSurface
NoArch
Mesh
Vertex3f
Vertex2f
Colour3f
Colour4f
Sound
ISound
ISoundBuffer
FMODSound
FMODSoundBuffer
SDLSound
SDLSoundBuffer
something like this, but I'm having trouble, whenever I try @defgroup for
the fusion core object for example, using these doxygen tags
/** @defgroup FusionGroup Fusion Core object
* @{
*/
some global pieces of data
/** @class FusionCore
* description
*/
class FusionCore{
etc etc etc
};
/** @} */
then it does create a module called Fusion, but when you go into it, only
the global variables are there, the fusion class isnt, it's containing in a
link, which is repeated twice to the class definition.
I think the reason for the duplicated link, is that doxygen doesnt
understand predeclared classes, as in, to get around circular #include'ing
anyone know what I should do, or suggestions on how I should organise this,
would be helpful!
thanks
kosh
_________________________________________________________
Do You Yahoo!?
Get your free @yahoo.com address at http://mail.yahoo.com
|