doxypress icon indicating copy to clipboard operation
doxypress copied to clipboard

Provide a way do hide implementation details in header only libraries.

Open purpleKarrot opened this issue 8 years ago • 1 comments

Header-only libraries often put implementation details into a special namespace (Boost libraries often use detail).

Implementation details should not be displayed in documentation. When a function returns a type that is an implementation detail, it should be displayed as unspecified.

Examples: http://www.boost.org/doc/libs/release/doc/html/boost/algorithm/is_alnum.html http://www.boost.org/doc/libs/release/libs/core/doc/html/core/lightweight_test.html

purpleKarrot avatar May 20 '16 12:05 purpleKarrot

Doxypress, like Doxygen before it, should be able to exclude classes and namespaces. In DoxyPressApp, look under Build Settings Tab, Input Source Files option (on the left), under the Exclude Symbols area. Entering detail there should exclude the detail namespace from documentation.

TransientResponse avatar Jul 05 '16 20:07 TransientResponse