RE: [Doxygen-users] Newbie confused: How to document 'uncommon' c ode?

[Roy L. <Roy...@wd...>]

Hi Moritz,

I'd suggest that you break this up into two steps.  This makes it easier to
explain from C and from Doxygen.

typedef the function pointers above the structure

typedef void        (*t_functionOne)(void);		///< blah blah blah

typdef struct
{
	t_functionOne functionOne;		///< Blah Blah Blah
	...
}

Cheers,

Roy

-----Original Message-----
From: Moritz Voss [mailto:th...@gm...]
Sent: Wednesday, February 27, 2002 6:02 PM
To: Doxygen
Subject: [Doxygen-users] Newbie confused: How to document 'uncommon'
code?


Hello!
I am trying to figure out how to best document the interface structures we
use
in our project. The general deal is as follows: C-language, but
C++-class-like
interfaces are passed on between the modules. It'd be most intuitive to
describe
the function pointers in these interfaces instead of the actual
implementations
of the functions. The function members area actually filled in a constructor
method that is called upon loading of the module, which makes the process
logically opaque to all the other modules.

Example:
typedef struct
{
   void (*functionOne)   (void);
   void (*functionTwo)   (const char* two_parameter);
   int  (*functionThree) (int three_parameter);

} myInterface;


Addendum: These functions exist, with similar but not always identical
names,
however, as several interfaces in one module may have an 'open' member, for
example...

In this example, the actual implementations of the functions would thus
probably
be called "myintfunctionOne", etc.


--
Regards,
 Moritz Voss


_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users