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

Enable autobrief in Doxygen

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: base
    • Templates:
    • Story Points:
      0.5
    • Epic Link:
    • Sprint:
      Alert Production S17 - 12
    • Team:
      Alert Production

      Description

      AUTOBRIEF is turned off by default in our Doxygen configuration. The developers guide
      https://developer.lsst.io/docs/cpp_docs.html suggests using @brief but the very first example after that omits it and much of our code omits it. I think it should be optional and certainly much of our code reflects that.

      The proposed fix is set the following to YES in in `doc/base.inc`:

      • JAVADOC_AUTOBRIEF
      • QT_AUTOBRIEF

      We mostly use javadoc style, but there is no harm in supporting both, and some of our code may already use QT style.

        Attachments

          Container Issues

            Issue Links

              Activity

                People

                • Assignee:
                  rowen Russell Owen
                  Reporter:
                  rowen Russell Owen
                  Reviewers:
                  Krzysztof Findeisen
                  Watchers:
                  Jonathan Sick, Kian-Tat Lim, Krzysztof Findeisen, Russell Owen
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  4 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Summary Panel