Move all comments from cpp to headers

AgreeableDeerGames / GameBackbone

2D game framework

MIT License

11 stars 4 forks source link

Move all comments from cpp to headers #239

Closed gyurgyma closed 3 years ago

gyurgyma commented 4 years ago

Is your feature request related to a problem? Please describe. Having our documentation in cpps was always bad, but with more and more templates, the documentation is split between headers and cpps.

Describe the solution you'd like All documentation should be moved to headers.

lavinrp commented 4 years ago

When we do this it would also be nice to switch to Doxygen style comments instead of XML comments.

Its more common in C++ and much less verbose

lavinrp commented 4 years ago

feature/i239-header_comments has updated our comment style for everything but CompoundSprite (I didn't want to have a huge merge conflict with Chris's changes). It currently depends on https://github.com/AgreeableDeerGames/GameBackbone/pull/254 (also because I didn't want to have a huge merge conflict).

lavinrp commented 3 years ago

Closed with https://github.com/AgreeableDeerGames/GameBackbone/pull/257