RE: [Doxygen-users] Member function puzzle

[Glenn M. <gle...@vo...>]

The @class/@fn Doxygen commands followed by a prototype are only need to
be used when the comment is _not_ directly in front of its associated
code item either in the header or the source file. It is useful if you
have to keep your documentation in separate files.=20

(I use it when a class implements a feature that is called by a
function; I expose the function but not the class. The class is where
the developer goes to change how the function works. Moreover, the
function is "generated." Hence, I use @fn to get it to the function
definition.)

Secondly, when @class or @fn is used, it needs to be followed on one
line by the exact prototype. Otherwise it won't be able to match it.

In your case, you don't need the @class. Your comments appear in front
of the owning element. You could safely remove that line (which is a
maintenance hassle anyway.)

If you did use the @class, it would need to be:

/*! @class template <class Return> inline RWTRunnableIOUFunction
Return>::RWTRunnableIOUFunction(void)
  * [above should all be on one line.]
  *  Yes, I'm documented.
  */

Glenn Maxey
Technical Writer
Voyant Technologies, Inc.
1765 West 121st Avenue
Westminster, CO 80234-2301
Tel. +1 303.223.5164
Fax. +1 303.223.5275
gle...@vo...


> -----Original Message-----
> From: Marc Betz [mailto:be...@ro...]
> Sent: Monday, December 03, 2001 2:05 PM
> To: 'dox...@li...'
> Subject: [Doxygen-users] Member function puzzle
>=20
>=20
> The following class
>=20
> /*! @class RWTRunnableIOUFunction<Return>
>  *  Yes, I'm documented.
>  */
> template <class Return>
> class RWTRunnableIOUFunction :
>    public RWRunnable {
>=20
>    public:
>=20
>       /*!=20
>        *  Yes, I'm documented.
>        */
>       RWTRunnableIOUFunction(void);
> };
>=20
> template <class Return>
> inline
> RWTRunnableIOUFunction<Return>::RWTRunnableIOUFunction(void)
> {
>    RW_THREAD_TRACEABLE_TEMPLATE_MEMBER("RWTRunnableIOUFunction_ctor",
> RWTRunnableIOUFunction)
> }
>=20
> results in this error
>=20
> RWTRunnableIOUFunction.h:30: Warning: no matching class=20
> member found for=20
>   RWTRunnableIOUFunction< Return >::RWTRunnableIOUFunction(void)
> Possible candidates:
>   RWTRunnableIOUFunction(void)
>=20
> Does anyone have any experience of this phenomenum, or any=20
> ideas what the
> problem might be?
>=20
> A few additional facts:
> - The actual class has about 15 functions, all of which=20
> generate the same
> type of error.
> - The class does appear in the doxygen output, with no member=20
> functions
> identified.
> - Commenting out the implementation line, with its macro=20
> frunction, does not
> eliminate the problem.
>=20
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>=20