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

Remove accidental Doxygen comments for namespace lsst

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: Science Pipelines
    • Labels:
      None
    • Story Points:
      6
    • Epic Link:
    • Sprint:
      AP F22-2 (July)
    • Team:
      Alert Production

      Description

      Unless explicitly instructed otherwise, Doxygen assumes all Doxygen comment blocks apply to the next code object. This has led to some file-specific comments being attached to namespace lsst, particularly if comment blocks are placed before included header files. The result is garbled or nonsense documentation like http://doxygen.lsst.codes/stack/doxygen/xlink_master_2020_01_08_09.10.02/namespacelsst.html#details.

      Namespace documentation was relatively invisible in the past, but may become more of a nuisance in the future; DM-22500 shows that exhale uses namespace documentation much more heavily than Doxygen itself does. Track down and clean up the misused comment blocks.

        Attachments

          Issue Links

          relates to

          Bug - A problem which impairs or prevents the functions of the product. DM-35793 sconsUtils cannot install doc directories that do not contain a config file II

          • To Do

          Bug - A problem which impairs or prevents the functions of the product. DM-35792 sconsUtils cannot install doc directories that do not contain a config file

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-22500 Trial generating C++ documentation for pipelines.lsst.io using "exhale"

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            krzys Krzysztof Findeisen added a comment - - edited

            Many thanks for agreeing to do this! In addition to the listed pull requests, there's afw#648.

            Show
            krzys Krzysztof Findeisen added a comment - - edited Many thanks for agreeing to do this! In addition to the listed pull requests, there's afw#648 .
            Hide
            Permalink
            jbosch Jim Bosch added a comment -

            All looks good, no comments on PRs.

            Show
            jbosch Jim Bosch added a comment - All looks good, no comments on PRs.

              People

              Assignee:
              krzys Krzysztof Findeisen
              Reporter:
              krzys Krzysztof Findeisen
              Reviewers:
              Jim Bosch
              Watchers:
              Jim Bosch, Krzysztof Findeisen
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.