# Clean up usage of detail namespaces

XMLWordPrintable

#### Details

• Type: Story
• Status: To Do
• Resolution: Unresolved
• Fix Version/s: None
• Component/s:
• Labels:
• Story Points:
1

#### Description

As noted in the review form DM-15563, we should be ignoring any detail namespaces when running Doxygen, as that namespace indicates symbols that should not be considered part of the public API. This can be done by setting:

 EXCLUDE_SYMBOLS = detail

in doxygen configuration.

However, for this to work, we'd actually need to standardize on whether to use detail or details as the namespace name, and a quick look at afw indicates that we haven't even done that.  This convention was invented by Boost, which uses detail and we should go with that.

#### Activity

Hide
Jim Bosch added a comment -

This is a sufficiently low priority that I'm almost inclined to just Won't Fix it, but it also looks so easy that we should probably just do it instead.

Show
Jim Bosch added a comment - This is a sufficiently low priority that I'm almost inclined to just Won't Fix it, but it also looks so easy that we should probably just do it instead.

#### People

Assignee:
Unassigned
Reporter:
Jim Bosch
Watchers:
Jim Bosch