rj00a / evenio

An event-driven Entity Component System
MIT License
132 stars 14 forks source link

It's documentation time #78

Open AsterixxxGallier opened 3 weeks ago

AsterixxxGallier commented 3 weeks ago

I documented all over the place!

Specifically these modules:

All public API was already documented, but not many internal functions. I added docs for most of them. I also added comments inside of some functions to explain their implementation. I added notes and TODOs whenever I saw something that I thought could be improved or optimized. However, apart from one test I added, the code itself was left untouched - no functionality changed, not even implementation details.

I hope this makes the codebase more navigable and understandable. I'm open to feedback, additions, changes and critique!