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

Replace Packages section in C++ Documentation Guide

    XMLWordPrintable

    Details

      Description

      The C++ documentation guide recommends providing package documentation using Doxygen groups, which are being phased out. The section on package documentation should be rewritten (possibly as a link) pointing developers to the new Sphinx-based system.

        Attachments

          Issue Links

          relates to

          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

            Activity

            Ascending order - Click to sort in descending order
            No builds found.
            krzys Krzysztof Findeisen created issue -
            krzys Krzysztof Findeisen made changes -
            Field Original Value New Value
            Epic Link DM-16722 [ 235355 ]
            krzys Krzysztof Findeisen made changes -
            Description The C++ documentation guide recommends providing package documentation using Doxygen groups, which are being phased out. It should be rewritten (possibly as a link) pointing developers to the new Sphinx-based system. The C++ documentation guide recommends providing package documentation using Doxygen groups, which are being phased out. The section on package documentation should be rewritten (possibly as a link) pointing developers to the new Sphinx-based system.
            Hide
            Permalink
            krzys Krzysztof Findeisen added a comment -

            The revised documentation should also include an explicit note that we no longer use file-level Doxygen comments.

            Show
            krzys Krzysztof Findeisen added a comment - The revised documentation should also include an explicit note that we no longer use file-level Doxygen comments.
            krzys Krzysztof Findeisen made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            krzys Krzysztof Findeisen made changes -
            Link This issue relates to RFC-225 [ RFC-225 ]
            Hide
            Permalink
            krzys Krzysztof Findeisen added a comment - - edited

            Hi Jim Bosch, since you were prominent in the discussion of this issue on Slack, would you be willing to review the new (greatly abbreviated) wording? Thanks!

            Show
            krzys Krzysztof Findeisen added a comment - - edited Hi Jim Bosch , since you were prominent in the discussion of this issue on Slack, would you be willing to review the new (greatly abbreviated) wording? Thanks!
            krzys Krzysztof Findeisen made changes -
            Reviewers Jim Bosch [ jbosch ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            Hide
            Permalink
            jbosch Jim Bosch added a comment -

            Looks great, thanks for taking care of this!

            Show
            jbosch Jim Bosch added a comment - Looks great, thanks for taking care of this!
            jbosch Jim Bosch made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            krzys Krzysztof Findeisen made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]

              People

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

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.