Doxygen - Document COM interface (or 'create' custom documentation)

Hi,

Maybe someone here has an idea if that is possible at all:

[Code in header]

class A
{
public:
   STDMETHOD(get_ValueFromA)(BOOL *pVal);
   STDMETHOD(set_ValueFromA)(BOOL newVal);
};

This is a [simplified] example for some COM interface code. After we finally got the macro expansion working correctly there still is the problem of 'too much'/wrong information.

If the class is documented 'normally' you get something like:

Public Member Functions

HRESULT get_ValueFromA (BOOL *pVal)
Property to control value in A (read).

HRESULT set_ValueFromA (BOOL newVal)
Property to control value in A (set).

However the ideal documentation format for the user would be something like:

Public Properties

ValueFromA (boolean)

etc.

Is there a way in Doxygen to document functions/properties that aren't actually there (I know it defeats the purpose somewhat...). Something like:

/// \property ValueFromA
/// \brief Control the value of A (boolean)

does not seem to work and any tries led to errors of the form

Warning: documented function 'A::ValueFromA' was not declared or defined

Thanks for any advise on the issue. Best regards, T

ansaurus

tags:

views:

answers:

Doxygen - Document COM interface (or 'create' custom documentation)

related questions