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

Transfer relevant C++ doc guidelines from Confluence to Developer Guide

    XMLWordPrintable

    Details

      Description

      Investigation supporting RFC-225 revealed that some rules in the Confluence documentation guidelines (e.g., the use of @ for Doxygen tags, or placing all documentation at the point of declaration) are not present in the developer guide. Ensure all relevant rules are present in the final documentation (senior developers have the final word on which rules are relevant).

        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

          RFC - An issue whose primary purpose is to advertise an intent and allow stakeholders to comment. RFC-307 Discourage use of @todo Doxygen tag

          • Implemented

            Activity

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

            K-T will have to approve any changes to the dev guide, regardless. An RFC might be appropriate, but it would be kind of weird given that this issue is already an implementation ticket for another RFC.

            Show
            krzys Krzysztof Findeisen added a comment - K-T will have to approve any changes to the dev guide, regardless. An RFC might be appropriate, but it would be kind of weird given that this issue is already an implementation ticket for another RFC.
            Hide
            Permalink
            tjenness Tim Jenness added a comment -

            You are stuck in a maze of twisty RFCs...

            K-T will have to approve the dev guide pull request before it can be merged anyhow.

            Show
            tjenness Tim Jenness added a comment - You are stuck in a maze of twisty RFCs... K-T will have to approve the dev guide pull request before it can be merged anyhow.
            Hide
            Permalink
            krzys Krzysztof Findeisen added a comment -

            Hi Kian-Tat Lim, could you please review DM-7892 and DM-9966? These are the final changes to the dev guide needed to close RFC-225 and RFC-307, and they're fairly small updates.

            Show
            krzys Krzysztof Findeisen added a comment - Hi Kian-Tat Lim , could you please review DM-7892 and DM-9966 ? These are the final changes to the dev guide needed to close RFC-225 and RFC-307 , and they're fairly small updates.
            Hide
            Permalink
            ktl Kian-Tat Lim added a comment -

            I think the one change affecting existing practice is the @code -> indent change. Please make sure to publicize this.

            Show
            ktl Kian-Tat Lim added a comment - I think the one change affecting existing practice is the @code -> indent change. Please make sure to publicize this.
            Hide
            Permalink
            krzys Krzysztof Findeisen added a comment -

            Merged and announced.

            Show
            krzys Krzysztof Findeisen added a comment - Merged and announced.

              People

              Assignee:
              krzys Krzysztof Findeisen
              Reporter:
              krzys Krzysztof Findeisen
              Reviewers:
              Kian-Tat Lim
              Watchers:
              John Swinbank, Kian-Tat Lim, Krzysztof Findeisen, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.