Re: [Doxygen-users] New project, and, Can Doxygen understand functions at namespace level?

[Dimitri v. H. <di...@st...>]

On Wed, Jun 27, 2001 at 06:04:27PM -0400, Phil Edwards wrote:
> Anyhow... I'm trying to comment the code for use with EXTRACT_ALL=NO,
> and am having problems with a template function at namespace level, using
> doxygen 1.2.6.  The code looks like this:
> 
>   namespace std {
> 
>     /**
>      *  ...some @-style tags in here...
>      *
>      *  The standard requires that the objects be passed by reference-to-const,
>      *  but LWG issue #181 says they should be passed by const value.
>      */
>     template <class _T1, class _T2>
>     #ifdef _GLIBCPP_RESOLVE_LIB_DEFECTS
>     //181.  make_pair() unintended behavior
>     inline pair<_T1, _T2> make_pair(_T1 __x, _T2 __y)
>     #else
>     inline pair<_T1, _T2> make_pair(const _T1& __x, const _T2& __y)
>     #endif
>     {
>       return pair<_T1, _T2>(__x, __y);
>     }
> 
>   }  // namespace std
> 
> Doxygen completely skips this function, no matter what I do.  However,
> if I move the code into the global namespace rather than namespace std,
> then make_pair correctly appears in the output.
> 
> What do I need to do for doxygen to see this function inside std:: correctly?

You need to document the namespace somewhere (a block with @namespace std
will do for instance), or put the function in a self defined group 
(see @defgroup, @ingroup, and friends).

Regards.
  Dimitri