Re: [Boost-docs] Reference to overloaded function from quickbook to doxygen

Subject: Re: [Boost-docs] Reference to overloaded function from quickbook to doxygen
From: Raffi Enficiaud (raffi.enficiaud_at_[hidden])
Date: 2014-12-17 09:13:02

The link you sent was exactly the result I wanted to obtain. After some struggling with Doxygen, it was a syntax issue:

1. This works:
    /// @overload boost::unit_test::data::random()

   This does not work:
   /*!
    * @overload boost::unit_test::data::random()
    */

2. return type confuses doxygen
3. namespace should be fully qualified

Thanks again. The warnings in quickbook generation have disappeared and the links are correct. 

Best regards,
Raffi Enficiaud

> On 16 Dec 2014, at 16:57, Antony Polukhin <antoshkka_at_[hidden]> wrote:
> 
> 
> 2014-12-16 17:48 GMT+03:00 Raffi Enficiaud <raffi.enficiaud_at_[hidden] <mailto:raffi.enficiaud_at_[hidden]>>:
> Thank you for your answer.
> 
> It does not seem like overload is helping in this case. The documentation of doxygen indicates that this might be used for overloaded *member* functions, so maybe this is the reason (using 1.8.6 BTW). The XML produced does not show any key that would enable the distinction of these 3 overloads, even with this keyword.
> 
> Actually, `\overload` keyword works even for global overloaded functions. For example: 
> 
> Source: https://github.com/apolukhin/Boost.DLL/blob/master/include/boost/dll/import.hpp#L72 <https://github.com/apolukhin/Boost.DLL/blob/master/include/boost/dll/import.hpp#L72>
> Result: http://apolukhin.github.io/Boost.DLL/boost/dll/import.html <http://apolukhin.github.io/Boost.DLL/boost/dll/import.html>
>  
> -- 
> Best regards,
> Antony Polukhin
> _______________________________________________
> Boost-docs mailing list
> Boost-docs_at_[hidden]
> http://lists.boost.org/mailman/listinfo.cgi/boost-docs