Skip to content

[FEATURE] Improve C++ code documentation #96

Open
@petersalemink95

Description

@petersalemink95

To make the C++ code easier to understand it would be nice to improve the code documentation.

Tasks:

  • Choose 1 style for code documentation and adjust all documentation to this style
  • Make sure the functions contain a clear explanation of the logic, the input arguments and the return type
  • Write some markdown documentation for developers about philosophical design choices.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueIndicates a good issue for first-time contributors

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions