Closed alandefreitas closed 3 weeks ago
There is a "document namespace" which removes the prefix "boost::urls" for example. This is a feature of docca not Doxygen, so it is not in the Doxyfile but rather the per-project docca config file located here:
https://github.com/boostorg/url/blob/develop/doc/xsl/custom-overrides.xsl#L8
std
gets away with it because it is just three characters, but if you fully qualify all the symbols in a Boost library documentation (URL for example) you have boost::urls::
repeated quite a lot. I've tried it that way and in my opinion it creates a lot of noise for little benefit. That is why this section is added to the docs:
There’s no way to tell from a symbol’s page what namespace we’re in. We can compare the titles of these two pages:
There's no need to say "Overload set" or "Members" either.
We'll also notice that Doxygen assumes we are always in the
boost::urls
namespace, so it only saysgrammar::parse
instead ofboost::urls::grammar::parse
. Because no options indicate this namespace in our Doxyfile, I can only assume it infersboost::urls
can be omitted because this is common to all symbols in our documentation. As this inference demands research, is hard to implement, and not strictly necessary for things to make sense (for instance, cppreference doesn't do it), I suggest we leave that to a separate issue.