rapida/docs/src/development.dox

/**

\page development Development

[TOC]

Overview
--------
We use:
- Catch2 library for writing tests.
  \warning We are currently on version 2.
- Doxygen to generate documentation.
- clangd for hints.
- clang-format for code formatting.
- GNU Make to build the project.
  You can see the targets, flags and arguments by runnig `make help`.


Code style
----------
We are using a WebKit-based coding style with some differences,
see `.clang-format` at the project root.

Please use the _clang-format_ to keep code style.

Also you can automatically run formatting with `make format`.


Licensing rules
---------------
Add an SPDX license notice to top of every file you create.
Notice format:
```
/* SPDX-License-Identifier: <SPDX License Expression> */
```

If you edit exist file, add your copyright info.
Copyright notice format:
```
/* Copyright <YEAR> <AUTHOR> */
```


Writing tests
-------------
For writing tests we are using the
[Catch2](https://github.com/catchorg/Catch2) library.
Read it's
[tutorial](https://github.com/catchorg/Catch2/blob/devel/docs/tutorial.md#top)
to be aware.

Tests placed at the `tests` directory of the project root and can be built
by ranning `make run_tests`. `run_tests` executable will be built.


Writing docs
------------
All code of this project should be documented,
for docs generation we are use [Doxygen](http://doxygen.nl).

See Doxygen documentation and existing code to see an examples.

Rules:
- Documentation pages like this placed in `docs/src`.
- Use Qt-style documentation.

 */