alpheios-project / documentation

Alpheios Developer Documentation
0 stars 0 forks source link

Added info about code's comments #45

Closed kirlat closed 3 years ago

kirlat commented 3 years ago

This is an attempt to describe some of the rules for documenting the code. That should help to make the code more understandable and more controllable through the static type checking (when information from the comments will be used by an IDE to check the correctness of types).

It also includes some minor improvements to the diagrams with purpose to update them to reflect the current state of things.