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

Clean up usage of detail namespaces

    XMLWordPrintable

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: afw, base
    • Story Points:
      1

      Description

      As noted in the review form DM-15563, we should be ignoring any detail namespaces when running Doxygen, as that namespace indicates symbols that should not be considered part of the public API. This can be done by setting:

      EXCLUDE_SYMBOLS = detail  

      in doxygen configuration.

      However, for this to work, we'd actually need to standardize on whether to use detail or details as the namespace name, and a quick look at afw indicates that we haven't even done that.  This convention was invented by Boost, which uses detail and we should go with that.

        Attachments

          Issue Links

            Activity

            No builds found.
            jbosch Jim Bosch created issue -
            jbosch Jim Bosch made changes -
            Field Original Value New Value
            Risk Score 0
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 32923 ]
            Hide
            jbosch Jim Bosch added a comment -

            This is a sufficiently low priority that I'm almost inclined to just Won't Fix it, but it also looks so easy that we should probably just do it instead.

            Show
            jbosch Jim Bosch added a comment - This is a sufficiently low priority that I'm almost inclined to just Won't Fix it, but it also looks so easy that we should probably just do it instead.

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              jbosch Jim Bosch
              Watchers:
              Jim Bosch
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins

                  No builds found.