Details
-
Type:
Improvement
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: base
-
Labels:
-
Story Points:2
-
Epic Link:
-
Sprint:Alert Production F16 - 10
-
Team:Alert Production
Description
To allow easier implementation of DM-7891, all DM projects' doxygen config files should include an alias @exceptsafe that expands to a paragraph with the heading "Exception Safety". The tag can be used to describe any guarantees made by documented code in the event of an exception.
Yes, this requires touching (almost) every repository in the stack.
Attachments
Issue Links
- is triggered by
-
RFC-225 Bring C++ doc standards in line with Python docs
- Implemented
Activity
My memory of this is a bit fuzzy now, but I think sconsUtils assembles the doxygen.conf files via some combination of each package's doxygen.conf.in file and its dependencies' <package>.inc files (those that exist; they're also in the doc directory). Most of the configuration options are in the base packages doc/base.inc file.
Hi John Swinbank, please quickly review this extension to the Doxygen settings. I ask because you've done some changes to the settings yourself, and I'd like somebody senior to confirm that adding this alias won't break anything in how the stack handles Doxygen configuration.
Krzysztof Findeisen
added a comment - Hi John Swinbank , please quickly review this extension to the Doxygen settings. I ask because you've done some changes to the settings yourself, and I'd like somebody senior to confirm that adding this alias won't break anything in how the stack handles Doxygen configuration. This is on my todo list, but I'm already quite booked up for the next few days: I might not get to it until the weekend. Does that work for you?
Yes, that's fine. (Don't worry, it's literally a one-line change.)
Krzysztof Findeisen
added a comment - Yes, that's fine. (Don't worry, it's literally a one-line change.) Looks fine. My only concern would be the lack of documentation, but I trust that will be forthcoming in DM-7891.
Yes, that's the obvious place for documenting the tag. Thanks for checking my work; changes merged to master.
Krzysztof Findeisen
added a comment - Yes, that's the obvious place for documenting the tag. Thanks for checking my work; changes merged to master. 
Jim Bosch, it looks like, at least in afw, doxygen.conf is generated automatically from some defaults and doxygen.conf.in. Do you know where that's controlled from? This kind of change should clearly be centralized if possible.