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

Let Doxygen report inherited methods inline

    XMLWordPrintable

    Details

    • Story Points:
      1
    • Sprint:
      Alert Production F17 - 9
    • Team:
      Alert Production

      Description

      Meredith Rawls showed me that the new Sphinx-based documentation system reports inherited methods as full documentation rather than as links to the base class documentation.

      If the plan for C++ code is still for Doxygen to produce XML output which is then fed to Sphinx (Jonathan Sick, is this still the case?), it would be helpful to set INLINE_INHERITED_MEMB to YES so that it has the same behavior.

        Attachments

          Activity

          Hide
          jsick Jonathan Sick added a comment -

          This sounds like a good idea.

          Show
          jsick Jonathan Sick added a comment - This sounds like a good idea.
          Hide
          krzys Krzysztof Findeisen added a comment -

          Hi Tim Jenness, can you review this ticket (and one pytest-related fix that came up while testing it)?

          Show
          krzys Krzysztof Findeisen added a comment - Hi Tim Jenness , can you review this ticket (and one pytest -related fix that came up while testing it)?
          Hide
          tjenness Tim Jenness added a comment -

          The one liner change is presumably fine if everyone else agrees that this is what they want. I haven't really got an opinion on the C++ documentation. The pytest file is annoying and turns up because the session file plugin is always enabled – you get that file when you run pytest yourself, not from within scons.

          Show
          tjenness Tim Jenness added a comment - The one liner change is presumably fine if everyone else agrees that this is what they want. I haven't really got an opinion on the C++ documentation. The pytest file is annoying and turns up because the session file plugin is always enabled – you get that file when you run pytest yourself, not from within scons .

            People

            Assignee:
            krzys Krzysztof Findeisen
            Reporter:
            krzys Krzysztof Findeisen
            Reviewers:
            Tim Jenness
            Watchers:
            Jonathan Sick, Krzysztof Findeisen, Tim Jenness
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.