[docbook] Add detail namespace to Reference section
Hi, I have the following example code fragment: namespace boost { namespace detail { /** documentation */ class implementation {}; } // namespace detail using detail::implementation; } // namespace boost I'd like to have the class `implementation` show up in the Reference section generated by doxygen+docbook-xsl+boost build+docbook+... . Issue is, every namespace which name contains the string "detail" is excluded somehow. The direct output of doxygen has it, but not the docbook version. I couldn't find any EXCLUDE_SYMBOLS setting (it's not set in the doxyfile)or anything relevant amongst the docbook-xsl params or in the boost build scripts. Google search term "doxygen ignores detail namespace" and the like did not help. Adding documentation to the using statement and/or TYPEDEF_HIDES_STRUCT did not help. Thanks, Benedek
On August 16, 2014 9:21:03 AM EDT, Benedek Thaler
Hi,
I have the following example code fragment:
namespace boost { namespace detail { /** documentation */ class implementation {}; } // namespace detail
using detail::implementation;
} // namespace boost
I'd like to have the class `implementation` show up in the Reference section generated by doxygen+docbook-xsl+boost build+docbook+... .
Issue is, every namespace which name contains the string "detail" is excluded somehow. The direct output of doxygen has it, but not the docbook version.
I don't know how to make it appear, but the real question is why you would want to document and implementation detail. ___ Rob (Sent from my portable computation engine)
On Sat, Aug 16, 2014 at 4:00 PM, Rob Stewart
I don't know how to make it appear, but the real question is why you would want to document and implementation detail.
As shown in the example, the class to be documented is lifted to the public namespace. Real code: https://github.com/erenon/pipeline/blob/master/include/boost/pipeline/type_e... It can't be in the public namespace because related operators are in the detail namespace which also serve other classes in the that namespace. Benedek
On August 16, 2014 10:06:05 AM EDT, Benedek Thaler
On Sat, Aug 16, 2014 at 4:00 PM, Rob Stewart
wrote: I don't know how to make it appear, but the real question is why you would want to document an implementation detail.
As shown in the example, the class to be documented is lifted to the public namespace. Real code: https://github.com/erenon/pipeline/blob/master/include/boost/pipeline/type_e...
It can't be in the public namespace because related operators are in the detail namespace which also serve other classes in the that namespace.
If you're lifting them into the public namespace, they aren't implementation details. Choose another name for the namespace with those identifiers and keep only implementation details in the detail namespace. ___ Rob (Sent from my portable computation engine)
participants (2)
-
Benedek Thaler
-
Rob Stewart