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

Doxygen tries to parse pybind11 wrappers

    XMLWordPrintable

    Details

    • Story Points:
      2
    • Epic Link:
    • Sprint:
      Alert Production F17 - 9
    • Team:
      Alert Production

      Description

      Doxygen currently reads .cc files in the python/ directory, leading to silly documentation like https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/namespacelsst_1_1afw_1_1camera_geom.html#a2a868ed61ae08543a5cc793c35f5674e.

      I propose that any C++ files in python/ be excluded using an EXCLUDE or EXCLUDE_PATTERNS configuration. I'm not sure whether this only needs to be changed in base or in all packages.

        Attachments

          Activity

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

          Hi Pim Schellart [X], can you please review this fix for the contents of pybind11 wrappers appearing in Doxygen documentation? (In particular, will my fix suppress any legitimate code that lives in python/?) Thanks!

          Show
          krzys Krzysztof Findeisen added a comment - Hi Pim Schellart [X] , can you please review this fix for the contents of pybind11 wrappers appearing in Doxygen documentation? (In particular, will my fix suppress any legitimate code that lives in python/ ?) Thanks!
          Hide
          Permalink
          pschella Pim Schellart [X] (Inactive) added a comment -

          Looks good!

          Show
          pschella Pim Schellart [X] (Inactive) added a comment - Looks good!
          Hide
          Permalink
          krzys Krzysztof Findeisen added a comment -

          Thanks!

          Show
          krzys Krzysztof Findeisen added a comment - Thanks!

            People

            Assignee:
            krzys Krzysztof Findeisen
            Reporter:
            krzys Krzysztof Findeisen
            Reviewers:
            Pim Schellart [X] (Inactive)
            Watchers:
            Krzysztof Findeisen, Pim Schellart [X] (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.