Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-7893

Add exception safety tag to Doxygen

    Details

      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

            Activity

            Hide
            krzys Krzysztof Findeisen added a comment -

            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.

            Show
            krzys Krzysztof Findeisen added a comment - 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.
            Hide
            jbosch Jim Bosch added a comment -

            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.

            Show
            jbosch Jim Bosch added a comment - 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.
            Hide
            krzys 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.

            Show
            krzys 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.
            Hide
            swinbank John Swinbank added a comment -

            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?

            Show
            swinbank John Swinbank added a comment - 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?
            Hide
            krzys Krzysztof Findeisen added a comment -

            Yes, that's fine. (Don't worry, it's literally a one-line change.)

            Show
            krzys Krzysztof Findeisen added a comment - Yes, that's fine. (Don't worry, it's literally a one-line change.)
            Hide
            swinbank John Swinbank added a comment -

            Looks fine. My only concern would be the lack of documentation, but I trust that will be forthcoming in DM-7891.

            Show
            swinbank John Swinbank added a comment - Looks fine. My only concern would be the lack of documentation, but I trust that will be forthcoming in DM-7891 .
            Hide
            krzys Krzysztof Findeisen added a comment -

            Yes, that's the obvious place for documenting the tag. Thanks for checking my work; changes merged to master.

            Show
            krzys Krzysztof Findeisen added a comment - Yes, that's the obvious place for documenting the tag. Thanks for checking my work; changes merged to master.

              People

              • Assignee:
                krzys Krzysztof Findeisen
                Reporter:
                krzys Krzysztof Findeisen
                Reviewers:
                John Swinbank
                Watchers:
                Jim Bosch, John Swinbank, Krzysztof Findeisen
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel