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

Add detailed C++ documentation guidelines

    Details

    • Templates:
    • Story Points:
      6
    • Epic Link:
    • Sprint:
      Alert Production F16 - 11, Alert Production F16 - 11b, Alert Production F16 - 11c, Alert Production S17 - 12, Alert Production S17 - 1, Alert Production S17 - 2
    • Team:
      Alert Production

      Description

      Modify the page Documenting C++ Code in the LSST Developer Guide to conform to RFC-225, including changes made in the discussion section. The final result should look similar to Documenting Python APIs.

      The page is considered part of the C++ Style Guide, so these changes must be approved by the System Architect. They should also be approved by as many senior C++ developers as is practical.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                krzys Krzysztof Findeisen
                Reporter:
                krzys Krzysztof Findeisen
                Reviewers:
                Jim Bosch, Kian-Tat Lim, Russell Owen
                Watchers:
                Jim Bosch, Jonathan Sick, Kian-Tat Lim, Krzysztof Findeisen, Russell Owen
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel