asio
asio copied to clipboard
Wrong namespace for boost::asio::ip::make_address in the documentation
@Belgorodsky commented on Aug 26, 2018, 6:34 PM UTC:
In the documentation of 1.68.0 here: https://www.boost.org/doc/libs/1_68_0/doc/html/boost_asio/reference/ip__address/make_address.html "ip::address::make_address" in the title, but "ip::make_address" expected one
This issue was moved by chriskohlhoff from boostorg/asio#138.
@ednolan commented on Mar 30, 2020, 7:00 PM UTC:
This issue still exists in 1.72.0: https://www.boost.org/doc/libs/1_72_0/doc/html/boost_asio/reference/ip__address/make_address.html
@sly1061101 commented on Jun 26, 2020, 2:34 AM UTC:
still exists in 1.73 https://www.boost.org/doc/libs/1_73_0/doc/html/boost_asio/reference/ip__address/make_address.html
@mrakh commented on Aug 11, 2020, 9:43 PM UTC:
Yep, this error had me scratching my head for a while.
still exists in 1.77 https://www.boost.org/doc/libs/1_77_0/doc/html/boost_asio/reference/ip__address/make_address.html
Issue still exists in 1.78: https://www.boost.org/doc/libs/1_78_0/doc/html/boost_asio/reference/ip__address/make_address.html
Same problem with operator<<
(although not as critical):
https://www.boost.org/doc/libs/1_78_0/doc/html/boost_asio/reference/ip__address/operator_lt__lt_.html
It seems to be an error in the way the documentation generates this namespace reference. The class address
closes just before those functions are defined.
This is an issue in Doxygen, not in Asio. I was able to reproduce it and thus opened an issue with them: https://github.com/doxygen/doxygen/issues/9083
After discussion with Doxygen developer, the issue is the use of the \relates
command. We should be using \relatesalso
instead, as that would not modify the namespace.
just in case, this issue is still present in the latest 1.82 version of the documentation