power-grid-model icon indicating copy to clipboard operation
power-grid-model copied to clipboard

[FEATURE] Improve C++ code documentation

Open petersalemink95 opened this issue 2 years ago • 0 comments

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.

petersalemink95 avatar Jul 13 '22 06:07 petersalemink95