uranos/README.md

Blokk

Conventions

KDoc

1. If the name of the target is already sufficient for understanding what it does/represents, you should not add a comment. But if you want to provide additional information, you should start the comment with a short description nevertheless.
2. The name of the return type, property type or type of the enclosing class should not be wrapped in square brackets.
3. If a comment only consists of the @returns block tag, the latter should be replaced with a sentence starting with Returns .

Code

1. If a member function of a class creates an instance of another class which represents the same value, the function’s name should be as<name of the other class>. If the new instance does not exactly represent the value of the original instance (for example because it is rounded), the name should be to<name of the other class>.