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

Use EXCLUDE_PATTERNS more safely afw Doxygen config

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: afw
    • Story Points:
      0.25
    • Epic Link:
    • Sprint:
      AP S18-5
    • Team:
      Alert Production

      Description

      In DM-14001 I used EXCLUDE_PATTERNS in the Doxygen config in order to stop scanning the source, since all the C++ Doxygen documentation is in header files. However Krzysztof Findeisen tells me that this will affect other packages as well, so exclusion has to be done more carefully.

        Attachments

          Issue Links

          relates to

          Improvement - An improvement or enhancement to an existing feature or task. DM-14001 Make afw PEP8 compliant and enable auto testing

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            rowen Russell Owen added a comment -

            Doxygen builds with no warnings (other than the known ndarray warning). I hope this version is safe enough for you.

            I sorted the EXCLUDEs so it is easier to find items.

            Show
            rowen Russell Owen added a comment - Doxygen builds with no warnings (other than the known ndarray warning). I hope this version is safe enough for you. I sorted the EXCLUDEs so it is easier to find items.
            Hide
            Permalink
            krzys Krzysztof Findeisen added a comment -

            Looks good. Sorry for the trouble!

            Show
            krzys Krzysztof Findeisen added a comment - Looks good. Sorry for the trouble!
            Hide
            Permalink
            rowen Russell Owen added a comment - - edited

            Krzysztof Findeisen thank you very much for the helpful advice. As you suggested, I added "afw" to the pattern used for EXCLUDE_PATTERNS. That works and seems safer than what I first tried. It's also nice and short.

            Show
            rowen Russell Owen added a comment - - edited Krzysztof Findeisen thank you very much for the helpful advice. As you suggested, I added "afw" to the pattern used for EXCLUDE_PATTERNS . That works and seems safer than what I first tried. It's also nice and short.
            Hide
            Permalink
            krzys Krzysztof Findeisen added a comment -

            Looks good.

            Show
            krzys Krzysztof Findeisen added a comment - Looks good.

              People

              Assignee:
              rowen Russell Owen
              Reporter:
              rowen Russell Owen
              Reviewers:
              Krzysztof Findeisen
              Watchers:
              Krzysztof Findeisen, Russell Owen
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.