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

Enable autolinking in Doxygen

    XMLWordPrintable

    Details

    • Story Points:
      1
    • Epic Link:
    • Sprint:
      Alert Production S17 - 2
    • Team:
      Alert Production

      Description

      During review of DM-7891, Jonathan Sick said he intends for the final LSST documentation to link all mentions of API components, and requested that a style rule concerning manual links (@ref) be removed from the draft style guidelines. Without such a rule, however, current documentation will have no links at all.

      Since it would be simpler to not introduce the rule now than to request/approve its removal later, the best solution is to enable Doxygen's autolinking, removing the need for @ref tags. This change should not cause compatibility problems for existing documentation that uses @ref.

        Attachments

          Issue Links

          is triggered by

          RFC - An issue whose primary purpose is to advertise an intent and allow stakeholders to comment. RFC-225 Bring C++ doc standards in line with Python docs

          • Implemented
          relates to

          Improvement - An improvement or enhancement to an existing feature or task. DM-7891 Add detailed C++ documentation guidelines

          • Done

            Activity

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

            Hi Jonathan Sick, please confirm this (one-line) change to the Doxygen settings.

            Show
            krzys Krzysztof Findeisen added a comment - Hi Jonathan Sick , please confirm this (one-line) change to the Doxygen settings.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Thanks Krzysztof Findeisen, I'll do a doc build and should be able to confirm this next week.

            Show
            jsick Jonathan Sick added a comment - Thanks Krzysztof Findeisen , I'll do a doc build and should be able to confirm this next week.
            Hide
            Permalink
            krzys Krzysztof Findeisen added a comment -

            Hi, were you able to confirm that nothing broke?

            Show
            krzys Krzysztof Findeisen added a comment - Hi, were you able to confirm that nothing broke?
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Looking at this now! Sorry for the delay.

            Show
            jsick Jonathan Sick added a comment - Looking at this now! Sorry for the delay.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            This works and introduces a huge usability improvement. See screen shots in PR. Thanks for doing this.

            Show
            jsick Jonathan Sick added a comment - This works and introduces a huge usability improvement. See screen shots in PR. Thanks for doing this.

              People

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

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.