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

Remove accidental Doxygen comments for namespace lsst

    Details

    • Type: Improvement
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: Science Pipelines
    • Labels:
      None

      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

            There are no comments yet on this issue.

              People

              • Assignee:
                Unassigned
                Reporter:
                krzys Krzysztof Findeisen
                Watchers:
                Krzysztof Findeisen
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: