| ... | ... | @@ -63,3 +63,8 @@ The syntax documentation can be found [here](https://www.doxygen.nl/manual/docbl |
|
|
|
* Includes of our own project files must be done using quotes and NOT angle brackets. The latter is reserved for external dependencies.
|
|
|
|
- If the file one wants to include is in the same directory or downstream, one must use relative paths.
|
|
|
|
- If the file is upstream, one must use absolute path, starting from the project's root folder, e.g. in `Core/TypeTraits/TypeTraits-Position.h`, include towards `Core/Types/Position.h` is done as: `#include <Core/Types/Position.h>` **Traversing tree by using `..` is forbidden.**
|
|
|
|
* In tests, use of `auto` keyword is not allowed: every type must be explicitly stated.
|
|
|
|
* Exceptions handling:
|
|
|
|
* Don't throw on implementation errors.
|
|
|
|
* Throw always on error caused by users.
|
|
|
|
* Test implementation thoroughly. Example: Getting null pointer due to failed construction is not internally checked, either it should throw because of wrong input or it should work. On the other when using PC, check for existence of DoF `"index_manager"` as user might have deleted it. |
|
|
\ No newline at end of file |
