Details
-
Type:
Improvement
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: ip_diffim
-
Labels:
-
Story Points:1
-
Epic Link:
-
Sprint:AP S18-4
-
Team:Alert Production
Description
ip_diffim's Doxygen settings were modified in 2014 to generate HTML documentation for both public and private members. Because of how the build system handles Doxygen overrides, this change had the (presumably unintended) consequence that the Stack-wide documentation also exposed private class members, whether or not they had documentation comments.
Per RFC-451, the override will be removed, so that both ip_diffim's and the Stack's documentation includes only API members.
Attachments
Issue Links
- is triggered by
-
RFC-451 Do not document private class members in published Stack API documentation
- Implemented
Hi Jonathan Sick, can you review this one-line config change?