[Doxygen-users] Including external documentation

[jalal @ g. <ja...@gn...>]

Hi Glenn

Many thanks, that seems to have fixed it.

Putting the filename didn't seem to effect the @class line, but it
stopped the @fn line from working.

Thanx

jalal

FROM: Glenn Maxey
DATE: 12/31/2001=FF07:20:35
SUBJECT: RE:  [Doxygen-users] Including external documentation

Everything may be on one line, but what stands out to me as a possible
error is that your @class and @fn prototypes also list the file name,
AltCtrlx.h. This could certainly contribute to the prototypes not
matching what Doxygen extracts.

Only on your first @file reference do you need that file name.

HTH.

Glenn


> -----Original Message-----
> From: jalal @ gnomedia [mailto:<EMAIL: PROTECTED>]
> Sent: Saturday, December 29, 2001 9:38 AM
> To: <EMAIL: PROTECTED>
> Subject: [Doxygen-users] Including external documentation
>
>
> Hi all
>
> I'm trying to document an existing library (the Windows
> Template Library), of which I have the header files and not
> much else. Nothing is documented in files and I can't change them.
> So, I have an external documentation file. In this I have,
> for example (this is an excerpt):
>
> /** @file AtlCtrlx.h
>     @brief bitmap button, check list view and other controls
> */
>
> /** @class WTL::CMultiPaneStatusBarCtrlImpl AtlCtrlx.h
>     @brief Class implementing a MultiPane status bar control
>     @see WTL::CMultiPaneStatusBarCtrl
> */
>
> /** @fn template<class T, class TBase =3D CStatusBarCtrl> BOOL
> WTL::CMultiPaneStatusBarCtrlImpl< T, TBase >::SetPanes(int*
> pPanes, int nPanes, bool bSetText =3D true) AtlCtrlx.h
>  *  @brief Sets the panes to values
>  *
>  *  Further instruction will go here.
>  */                                  
>
> Everything works very well, except for the @fn tag, which
> gives me '... not defined' error. I've tried every combination I can
> think of, but no way will Doxygen recognize it. (and yes,
> everything is on one line, I'm not sure what the emailer is
> going to do with it.)
>
> Any ideas?
>
> regards
> jalal
>
>