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

Remove accidental Doxygen comments for namespace lsst

    XMLWordPrintable

Details

    • Improvement
    • Status: Done
    • Resolution: Done
    • None
    • Science Pipelines
    • None
    • 6
    • AP F22-2 (July)
    • 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

          Activity

            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.

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

            All looks good, no comments on PRs.

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

            People

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

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.